v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB

Persons

Retrieves persons in sorted (by epoch) order

Retrieves a list of the persons you've created for one of your sub accounts They are returned in sorted (by epoch) order (default is newest first)

get/accounts/{id}/persons

Path parameters

idstring required

Example:ac_b83f2653-06d7-44a9-a548-5825e8186004

the account id of one of your sub accounts

Query parameters

ascendingboolean

Control the order (newest or oldest) in which the persons are returned. false will arrange the results with newest first whereas true shows oldest first.

limitinteger

Control how many persons are returned in the result list. The max limit we allow is 50.

Example:20

startsAfterstring

Example:per_01FCTS1XMKH9FF43CAFA4CXT3P

A token to identify where to resume a subsequent paginated query. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results.

Response

Successfully retrieved your persons

paginationTokenstring nullable

A token to use for getting the next page of results - send the same request with this value in the 'startsAfter' query parameter. This field is null when there are no further items to return

Example response

{
  "items": [
    {
      "id": "per_01G0EYVFR02KBBVE2YWQ8AKMGJ",
      "firstName": "Fred",
      "middleNames": "David",
      "lastName": "Jones",
      "email": "fred.jones@example.com",
      "dateOfBirth": "1990-01-20",
      "countryOfBirth": "GB",
      "gender": "Male",
      "nationalities": [
        "GB"
      ],
      "address": {
        "lineOne": "123 Test Street",
        "city": "Manchester",
        "country": "GB",
        "postalCode": "SP4 7DE"
      },
      "phoneNumber": "+447900000000",
      "businessRoles": [
        "BusinessContact",
        "Director"
      ],
      "verification": {
        "status": "Required",
        "requiredFields": [
          {
            "name": "phoneNumber"
          }
        ],
        "requiredDocuments": [
          {
            "category": "ProofOfIdentity",
            "types": [
              "BankStatement"
            ],
            "quantity": 1
          }
        ],
        "errors": [
          {
            "code": "InvalidDocument",
            "id": "fl_01HAAHFQKEF4V7S6H3BTA3H85G",
            "description": "File corrupted or image not clear"
          }
        ]
      },
      "documents": [
        {
          "type": "BankStatement",
          "category": "ProofOfIdentity",
          "front": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
          "back": "fl_01G0EYVFR02KBBVE2YWQ8AKMGJ",
          "status": "Pending",
          "invalidReason": "Document has expired",
          "country": "GB",
          "assignedTimestamp": 1470989538,
          "lastUpdatedTimestamp": 1470989538
        }
      ],
      "metadata": {
        "accountId": "1"
      },
      "createdTimestamp": 1470989538,
      "lastUpdatedTimestamp": 1470989538
    }
  ],
  "paginationToken": "per_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"
}