--- title: "Retrieves persons in sorted (by epoch) order" method: GET path: "/accounts/{id}/persons" tags: ["Persons"] --- # Retrieves persons in sorted (by epoch) order `GET /accounts/{id}/persons` 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) ## Path parameters - `id` string, required ## Query parameters - `ascending` boolean - `limit` integer — Control how many persons are returned in the result list. The max limit we allow is `50`. - `startsAfter` string ## Response `200` Successfully retrieved your persons - PersonsResponse - `items` PersonResponse[] - `id` string — The ID of the person - `firstName` string — The first name of the person - `middleNames` string, nullable — The middle names of the person - `lastName` string — The last name / surname of the person - `email` string, email, nullable — The email address of the person - `dateOfBirth` string — The date of birth of the person, in format YYYY-MM-DD - `countryOfBirth` string, nullable — The two-character ISO 3166 country code of birth of the person - `gender` 'Female' | 'Male', nullable — The gender of the person. International regulations require either `Female` or `Male` - `nationalities` string[] — The countries of citizenship or nationality of the person - `address` object — The address of the person - `lineOne` string, nullable — First line of the address. It must satisfy the following regex pattern: ^[A-Za-z0-9 !&'()+,-./:;]*$ - `lineTwo` string, nullable — Second line of the address. It must satisfy the following regex pattern: ^[A-Za-z0-9 !&'()+,-./:;]*$ - `city` string, nullable — The address city/town It must satisfy the following regex pattern: ^[A-Za-z0-9 !&'()+,-./:;]*$ - `country` string — The two-character ISO country code - `postalCode` string, nullable — The postal/zip code of the address. It must satisfy the following regex pattern: ^[A-Za-z0-9 -]*$ - `region` string, nullable — The state/county/province/region Required if the address is in the US/Canada and must be a 2-character ISO state/province code Otherwise it must satisfy the following regex pattern: ^[A-Za-z0-9 !&'()+,-./:;]*$ - `phoneNumber` string, nullable — The phone number of the person, in E.164 format - `businessRoles` BusinessRole[] — The role(s) in the business that the person performs - `verification` PersonVerification — the result of submitting a person for verification - `status` 'NotRequired' | 'Required' | 'PendingVerification' | 'Verified' - `requiredFields` object[], nullable — A list of fields that must be provided for verification. - `name` string — The name of the field - `requiredDocuments` object[], nullable — A list of documents that must be provided for verification. - `category` 'Authorization' | 'ProofOfAddress' | 'ProofOfBusiness' | 'ProofOfIdentity' — 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 - `types` AccountDocumentType[] — The types of document available to upload in this category - `quantity` integer — The minimum number of documents required of this category - `errors` object[], nullable — Details the errors returned if verification was unsuccessful. This could contain documents and/or fields. - `code` 'InvalidDocument' | 'InvalidField' - `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 - `description` string — A description of why this document/field was invalid - `documents` AccountDocumentResponse[], nullable — The KYC documents - `type` 'BankStatement' | 'BusinessRegistration' | 'CreditCardStatement' | 'DriversLicense' | 'LetterOfAuthorization' | 'NationalId' | 'OfficialGovernmentLetter' | 'Passport' | 'PropertyTaxAssessment' | 'TaxReturn' | 'UtilityBill' — The type of document, these are only applicable for certain entities: - 'LetterOfAuthorization' is only applicable for Persons, when the 'Authorization' category is required - 'BankStatement', 'CreditCardStatement', 'OfficialGovernmentLetter', 'PropertyTaxAssessment', 'TaxReturn', 'UtilityBill' are only applicable for Individuals or Persons, when the 'ProofOfAddress' category is required - 'BusinessRegistration' is only applicable for Businesses, when the 'ProofOfBusiness' category is required - 'DriversLicense', 'NationalId', 'Passport' are only applicable for Individuals or Persons, when the 'ProofOfIdentity' category is required - `category` 'Authorization' | 'ProofOfAddress' | 'ProofOfBusiness' | 'ProofOfIdentity' — 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 - `front` string — The ID of the uploaded file that shows the front of the document. - `back` string, nullable — The ID of the uploaded file that shows the back of the document. Required if uploading a `DriversLicense` or `NationalId`. - `status` 'Invalid' | 'Pending' | 'Valid' - `invalidReason` string, nullable — The reason for the document being invalid - `country` string, nullable — The two-character ISO 3166 country code of the document. Only present historically on documents with `type`: `Passport`, `DriversLicense`, `NationalId` - `assignedTimestamp` integer — The epoch timestamp (seconds) when the document was first assigned to the account - `lastUpdatedTimestamp` integer — The epoch timestamp (seconds) when the document was last updated - `metadata` object, nullable — 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. - `createdTimestamp` integer — The epoch timestamp (seconds) when the person was created - `lastUpdatedTimestamp` integer — The epoch timestamp (seconds) when the person was last updated - `paginationToken` string, 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 ## Other responses - `400` — One or more inputs are invalid - `500` — An unexpected error occurred when executing this request --- [API](https://skmtc.net/ryftpay/apis/ryft-payment-api.md) · [All operations](https://skmtc.net/ryftpay/apis/ryft-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ryftpay/ryft-payment-api/versions/a042f64d4305/schema)