Skip to main content
GET
/
v1
/
identity
/
accounts
List all accounts
curl --request GET \
  --url https://api.beltic.com/v1/identity/accounts \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "type": "account",
      "attributes": {
        "status": "active",
        "entity_type": "person",
        "external_id": "<string>",
        "person": {
          "name": {
            "first": "<string>",
            "middle": "<string>",
            "last": "<string>"
          },
          "birth_date": "<string>"
        },
        "business": {
          "legal_name": "<string>",
          "registration_date": "<string>",
          "shareholders": [
            {
              "name": "<string>",
              "shareholder_type": "<string>",
              "date_of_birth": "<string>",
              "id_type": "<string>",
              "id_number": "<string>",
              "number_of_share": "<string>",
              "percentage_of_share": 123
            }
          ]
        },
        "contact": {
          "email": "jsmith@example.com",
          "phone": "<string>"
        },
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "sublocality": "<string>",
          "locality": "<string>",
          "administrative_area": "<string>",
          "postal_code": "<string>",
          "country_code": "<string>"
        },
        "identity_numbers": [
          {
            "number": "<string>",
            "issuing_country_code": "<string>",
            "class": "<string>",
            "created_at": "<string>",
            "updated_at": "<string>"
          }
        ],
        "created_at": "<string>",
        "updated_at": "<string>",
        "redacted_at": "<string>"
      },
      "relationships": {
        "sessions": {
          "data": [
            {
              "type": "<string>",
              "id": "<string>"
            }
          ]
        },
        "documents": {
          "data": [
            {
              "type": "<string>",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "page": {
      "cursors": {
        "start": "<string>",
        "end": "<string>"
      },
      "hasNextPage": true,
      "hasPreviousPage": true,
      "total": 123
    }
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "last": "<string>"
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Access https://console.beltic.com/ to obtain your API key.

Query Parameters

​
page[size]
string

Number of items per page (default: 15)

Pattern: ^\d+$
Example:

"15"

​
page[after]
string

Cursor for fetching items after this point

Example:

"eyJ2YWx1ZXMiOnsiY3JlYXRlZF9hdCI6IjIwMjUtMTAtMjJUMjI6MTM6NDguMTQ5WiJ9LCJpZCI6IjNkZjk3MWQwLWNkNTYtNDAwNi05YmM0LTFjYmMzMjc1OWI2ZiJ9"

​
page[before]
string

Cursor for fetching items before this point

Example:

"eyJ2YWx1ZXMiOnsiY3JlYXRlZF9hdCI6IjIwMjUtMTAtMjJUMjI6MTM6NDguMTQ5WiJ9LCJpZCI6IjNkZjk3MWQwLWNkNTYtNDAwNi05YmM0LTFjYmMzMjc1OWI2ZiJ9"

​
page[total]
enum<string>

Include total count in response (may impact performance)

Available options:
true,
false
Example:

"true"

​
status
enum<string>

Filter accounts by status

Available options:
active,
inactive,
suspended,
pending
Example:

"active"

​
entity_type
enum<string>

Filter accounts by entity type

Available options:
person,
business
Example:

"person"

Response

Successfully retrieved accounts

​
data
object[]
required
​
meta
object
required
​
links
object
required