User
User schema defines a user, personal or business, as well as its documents, address and KYC status. Users are also identified by its id (UUID).
| Key | Description | Example |
|---|---|---|
| id | User UUID | 37fa27b6-a75b-4c02-b217-c1d337a6017c |
| externalId | User ID on your side, if known | ABC123456 |
| type | User type | personal or business |
| User email | [email protected] | |
| phone | Phone number (verified) with country code | 5511987654321 |
| status | User status | See remark #1 |
| associates | Business type only: company associates | See remark #2 |
| name | User full name | John Doe |
| document | User main identity or driver license number | AA123456 |
| cpfcnpj? 🇧🇷 | User's CPF (for personal) or CNPJ (for business) | 25082100050, 72046998000176 |
| address | User address in Address schema | See Address schema |
| createdAt | User creation timestamp | 2020-05-04T12:03:54.000000Z |
| updatedAt | User last change timestamp | 2020-05-04T12:03:54.000000Z |
Remarks
1. Possible user statuses
- unverified: users whose KYC details and doucments haven't been provided yet
- analyzing: users who have provided KYC details that are now being checked
- verified: users whose KYC has been verified
- failed: users who have provided the KYC details but such verification failed
- denied: users who have been denied at the KYC process for fraud history or high risk score (these users cannot retry)
- closed: users who have been requested to close their account on your side.
Note that it's possible to create orders for users under any statuses but only verified users will be able to complete their orders.
2. Regarding company associates
The associates key returns an array of other users's IDs (not externalIds), also in the same "id" property at the User schema.
For personal users, this key returns always an empty array ([]).
Updated 9 months ago