All profile endpoints require a valid Bearer token in the
Authorization header.Get profile
GET /v2/profile
Returns the authenticated user’s profile. This endpoint is used on the home screen, the profile screen, and the documents screen to populate user data and identity verification status.
Response
The user’s numeric database ID.
The user’s first name.
The user’s last name.
The user’s email address.
The user’s phone number.
Absolute URL of the user’s profile photo.
The user’s unique identifier. Used to generate the identity QR code.
URL of the front image of the uploaded national ID, if present.
URL of the back image of the uploaded national ID, if present.
URL of the front image of the uploaded passport, if present.
URL of the back image of the uploaded passport, if present.
URL of the front image of the uploaded driving licence, if present.
URL of the back image of the uploaded driving licence, if present.
Update name
POST /v2/update_name
Updates the authenticated user’s first and last name. Invalidates the cached profile on success.
Request body
The user’s new first name.
The user’s new last name.
Update email
POST /v2/update_email
Updates the authenticated user’s email address. The current email must be provided for verification.
Request body
The user’s current (old) email address.
The new email address to set.
Update phone
POST /v2/update_phone
Updates the authenticated user’s phone number. The current phone number must be provided for verification.
Request body
The user’s current phone number, including the country dial code.
The new phone number to set, including the country dial code.
Update profile photo
POST /v2/update_image
Uploads a new profile photo for the authenticated user. The request must be sent as multipart/form-data.
The image file is sent under the field name
image. The client supports both selecting from the photo library and capturing from the camera.Request body
The image file to upload. Sent as a
multipart/form-data part with the fields uri, type, and name.