Create an account for a given identity, via the identity_id
field.
This identity is the primary owner of the account for all tax-related purposes.
To track user balances using Paxos Profiles, use create_profile=true
when creating the account.
Once an account has been created, it is not possible to associate it with a Profile.
In addition to the primary owner, other identities may be associated with the account, by using members
.
The identity on the account is treated as a BENEFICIAL_OWNER.
To add a financial advisor to an account, add a member with the FINANCIAL_ADVISOR role.
This example request creates a joint account for John and Jane Doe. John has identity_id=82c338f4-3cb7-4d9b-be2a-4b077c82ee3a, and Jane has identity_id=0f5d8475-33f3-4ebd-88a0-66dedc2581c1. John is the primary owner of the account for tax-purposes, but Jane is a full beneficial owner.
Additionally, this account has an associated financial advisor with identity_id=0d26f878-298e-4d47-81be-cdf4e982a3d3.
{
"account": {
"identity_id": "82c338f4-3cb7-4d9b-be2a-4b077c82ee3a",
"members": [{
"identity_id": "0f5d8475-33f3-4ebd-88a0-66dedc2581c1",
"roles": ["BENEFICIAL_OWNER"]
}, {
"identity_id": "0d26f878-298e-4d47-81be-cdf4e982a3d3",
"roles": ["FINANCIAL_ADVISOR"]
}]
}
}
Any fields not listed are forbidden in this request.
Field | Notes |
---|---|
identity_id | Required |
description | Optional |
metadata | Optional |
ref_id | Optional |
members | Optional |
Paxos APIs use OAuth 2 with the client credentials grant flow.
Token URLs:
Learn more in the API credentials guide →
A successful response.
The response is of type object
.