Sign in

v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
User

Get a User Intent

📘

You can place your application's client_id into the username field, and your client_secret into the password form field of the Authentication section of this documentation 👉.

A User Intent manages the lifecycle of the creation of a User, before that User has been fully created. This endpoint retrieves the User Intent details.

📘

Note that the user_id will be returned in the payload if the UserIntent has been successfully converted to a User. Also note that a UserIntent does not need to have an Approved Status to be converted to a User.

get/v1/user_intent/{id}

Path parameters

idstring required

User intent ID

Response

Successful response

idstring

Unique Astra user intent ID

user_idstring

Unique Astra user ID

emailstring

Email address of the user

phonestring

Phone number of the user

first_namestring

First name of the user

last_namestring

Last name of the user

preferred_first_namestring

Preferred first name of the user

preferred_last_namestring

Preferred last name of the user

preferred_pronounsstring

Preferred pronouns of the user

status'approved' | 'pending' | 'retry' | 'document' | 'suspended' | 'rejected' | 'converted_to_user'

Current status of the user (Details on User Statuses)

kyc_type'receive-only' | 'unverified' | 'verified'

The verification type of the user, which determines the user's capabilities to send and/or receive funds