ASastra
User

Update User Email

Changed on

📘

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

🚧

Note that a user_updated webhook will fire upon successful email update for a given User.

🚧

Upon the third email change within a rolling 365 day window, the User's capabilities will be automatically downgraded. Details on User Capabilities here

patch/v1/users/{user_id}

Request

  • Base URL
    https://api-sandbox.astra.finance
  • URL
    https://api-sandbox.astra.finance/v1/users/{user_id}
  • Auth
    HTTP bearer

Path parameters

user_idstring required

User ID associated with the underlying access_token provided for authentication. The email of this User ID associated with the access_token will be updated.

Request body

emailstring required

The new email address for the User. Must be a valid email format.

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

Changes

  • 1f0b2e859333Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status