# 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) Endpoint: GET /accounts/{id}/persons Version: 1.1.0 Security: secretApiKeyAuth ## Path parameters: - `id` (string, required) the account id of one of your sub accounts Example: "ac_b83f2653-06d7-44a9-a548-5825e8186004" ## Query parameters: - `ascending` (boolean) 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. - `limit` (integer) Control how many persons are returned in the result list. The max limit we allow is 50. Example: 20 - `startsAfter` (string) 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. Example: "per_01FCTS1XMKH9FF43CAFA4CXT3P" ## Response 200 fields (application/json): - `items` (array) - `items.id` (string) The ID of the person Example: "per_01G0EYVFR02KBBVE2YWQ8AKMGJ" - `items.firstName` (string) The first name of the person Example: "Fred" - `items.middleNames` (string,null) The middle names of the person Example: "David" - `items.lastName` (string) The last name / surname of the person Example: "Jones" - `items.email` (string,null) The email address of the person Example: "fred.jones@example.com" - `items.dateOfBirth` (string) The date of birth of the person, in format YYYY-MM-DD Example: "1990-01-20" - `items.countryOfBirth` (string,null) The two-character ISO 3166 country code of birth of the person Example: "GB" - `items.gender` (string,null) The gender of the person. International regulations require either Female or Male Enum: "Female", "Male" - `items.nationalities` (array) The countries of citizenship or nationality of the person Example: ["GB"] - `items.address` (object) The address of the person - `items.phoneNumber` (string,null) The phone number of the person, in E.164 format Example: "+447900000000" - `items.businessRoles` (array) The role(s) in the business that the person performs Enum: "BusinessContact", "Director", "UltimateBeneficialOwner" - `items.verification` (object) the result of submitting a person for verification - `items.verification.status` (any) The verification status of the person - `items.verification.requiredFields` (array,null) A list of fields that must be provided for verification. - `items.verification.requiredFields.name` (string) The name of the field Example: "phoneNumber" - `items.verification.requiredDocuments` (array,null) A list of documents that must be provided for verification. - `items.verification.requiredDocuments.category` (string) The category of document, these are only applicable for certain entities: - Authorization is only applicable for Persons - ProofOfAddress is only applicable for Individuals or Persons - ProofOfBusiness is only applicable for Businesses - ProofOfIdentity is only applicable for Individuals or Persons Enum: "Authorization", "ProofOfAddress", "ProofOfBusiness", "ProofOfIdentity" - `items.verification.requiredDocuments.types` (array) The types of document available to upload in this category Enum: "BankStatement", "BusinessRegistration", "CreditCardStatement", "DriversLicense", "LetterOfAuthorization", "NationalId", "OfficialGovernmentLetter", "Passport", "PropertyTaxAssessment", "TaxReturn", "UtilityBill" - `items.verification.requiredDocuments.quantity` (integer) The minimum number of documents required of this category Example: 1 - `items.verification.errors` (array,null) Details the errors returned if verification was unsuccessful. This could contain documents and/or fields. - `items.verification.errors.code` (string) Enum: "InvalidDocument", "InvalidField" - `items.verification.errors.id` (string) For InvalidDocument this will be the file id of the document that is invalid For InvalidField this will be the name of the field that is invalid Example: "fl_01HAAHFQKEF4V7S6H3BTA3H85G" - `items.verification.errors.description` (string) A description of why this document/field was invalid Example: "File corrupted or image not clear" - `items.documents` (array,null) The KYC documents - `items.metadata` (object,null) use this parameter to attach key-value data to the person. These will be sent with any associated account events on your webhooks. You can have a maximum of 5 pieces of metadata. Example: {"accountId":"1"} - `items.createdTimestamp` (integer) The epoch timestamp (seconds) when the person was created Example: 1470989538 - `items.lastUpdatedTimestamp` (integer) The epoch timestamp (seconds) when the person was last updated Example: 1470989538 - `paginationToken` (string,null) 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: "per_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473" ## Response 400 fields (application/json): - `requestId` (string) Example: "b83f2653-06d7-44a9-a548-5825e8186004" - `code` (string) Example: "400" - `errors` (array) - `errors.message` (string) Example: "Required property 'amount' not found in JSON" ## Response 500 fields (application/json): - `requestId` (string) Example: "b83f2653-06d7-44a9-a548-5825e8186004" - `code` (string) Example: "400" - `errors` (array) - `errors.message` (string) Example: "Required property 'amount' not found in JSON"