Overview
A profile is associated with an account and provides additional detail about the account owner.
To customize a profile based on requirements specific of the user's country of origin, business area, etc., add custom fields as key-value pairs to the custom_fields property.
Note that you don't create a profile manually. A profile is created automatically when you create an account. Using the endpoints in this section you can view, update and delete profiles.
Properties of the Profile object
| Name | Type | Description |
|---|---|---|
id | String | The profile ID |
custom_fields | Object | Any custom fields this profile must have are stored as key-vale pairs in this property. |
address | String | Street address |
phone | String | Phone number |
gender | String | User's gender |
birthday | String | User's date of birth. Format: YYYY-MM-DD |
locale | String | ISO 639-1 language code |
account | String | The ID of the account that this profile belongs to |
cpf | String | CPF number (used in Brazil) |
avatar | String | The URL of the avatar image in cloud storage |
created_at | DateTime | The date and time when the profile was created |
updated_at | DateTime | The date and time when the profile was updated |