Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Accounts

get/identity/accounts/{id}

Path parameters

idstring required

uuid id of account

Response

A successful response.

idstring

The id used for all other interactions with this account. Required on update. Auto-generated on create; do not set.

identity_idstring

The primary identity associated with the account. Required on create. Not writable on update.

descriptionstring

A free-text description of the account.

admin_disabledboolean

true if the account has been disabled by a Paxos admin.

user_disabledboolean

true if the account has been disabled by the API user.

metadataobject

API User-facing metadata.

ref_idstring

A user-facing ID to prevent duplicate account creation. Unique for all accounts created by the same API user.

created_atstring date-time

The time this account was created.

summary_status'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED'
updated_atstring date-time

The time this account was updated.

profile_idstring

The ID of the profile created for the account when create_profile=true. The Profile type is NORMAL. The field is omitted when the account has no associated Profile.

type'BROKERAGE' | 'TRADITIONAL_IRA' | 'ROTH_IRA' | 'SEP_IRA' | 'FINANCIAL_ADVISOR'