Skip to main content
GET
/
v1
/
identities
Get Identities
curl --request GET \
  --url https://sandbox-api.borderless.xyz/v1/identities \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "<string>",
      "type": "Personal",
      "status": "Active",
      "suspensionReason": "<string>",
      "deleted": true,
      "hasComplianceChecks": true,
      "data": {
        "firstName": "<string>",
        "lastName": "<string>",
        "secondLastName": "<string>",
        "middleName": "<string>",
        "taxId": "<string>",
        "dateOfBirth": "YYYY-MM-DD",
        "email": "<string>",
        "phone": "<string>",
        "activity": "<string>",
        "sex": "Male",
        "address": {
          "id": "<string>",
          "street1": "<string>",
          "street2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "AF",
          "postalCode": "<string>"
        },
        "documents": [
          {
            "id": "<string>",
            "issuingCountry": "AF",
            "type": "Passport",
            "idNumber": "<string>",
            "issuedDate": "YYYY-MM-DD",
            "expiryDate": "YYYY-MM-DD"
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

namePrefix
string

Prefix for filtering identities by name

emailPrefix
string

Prefix for filtering identities by email

type
enum<string>

Type of identity (Personal or Business

Available options:
Personal,
Business
startingAfter
string

Id used to retrieve results that come after the specified item.

limit
number

Response page limit. Min 1, Max 100, Default value is 10.

Response

200 - application/json

List of Identities and hasMore flag.

hasMore
boolean
required
data
object[]
required