Sign in

v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
User

Get a User Profile

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

This endpoint retrieves the profile information for the User whose access_token is passed in the authorization header.

get/v1/user

Response

Successful response

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'

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