Update Account

This enables you to update an existing account with new information. Please refer to the following table for fields that can be updated via this endpoint.

Field	Notes
account.id	Required
account.description	Optional
account.ref_id	Optional
account.metadata	Optional. This will overwrite any existing metadata added to the account.
account.members	Optional. The only roles that can be added/removed are FINANCIAL_ADVISOR or AUTHORIZED_USER. You must always specify the full members object as we do not currently support differential member updates.
set_user_disabled	Optional. Setting this to true will disable the account, limiting its ability to be used within the Paxos platform.

Example Requests

Disabling an account

{
"set_user_disabled": true,
"account": {
"id": "82c338f4-3cb7-4d9b-be2a-4b077c82ee3a",
"description": "Account Description",
"ref_id": "82c338f4-3cb7"
}
}

Adding an account member

To retain the existing account members and add a new account member, the members field must contain the existing account members and the new member. The below example adds an AUTHORIZED_USER to the account.

In order to add account members while leaving existing account members unaffected, clients should use the Add Account Members API.

{
"account": {
"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"]
}, {
"identity_id": "012k23eb-298e-4d47-81be-cdf4e982a3d3",
"roles": ["AUTHORIZED_USER"]
}]
}
}

Removing an account member

To remove an existing account member and retain other needed members, the members field must contain the existing account members without the account member you’d like to remove. The below example removes an AUTHORIZED_USER from the account.

Note, this API requires the members array to have at least one element. In order to delete all members from an account, clients should use the Delete Account Member API.

{
"account": {
"id": "82c338f4-3cb7-4d9b-be2a-4b077c82ee3a",
"members": [{
"identity_id": "0f5d8475-33f3-4ebd-88a0-66dedc2581c1",
"roles": ["BENEFICIAL_OWNER"]
}]
}
}

Updating an account members’ roles

To update an account members’ roles, the members field must contain all the existing members with their roles along with the additional role that you’d like to add or remove. The below example adds the FINANCIAL_ADVISOR role to an member that is already a BENEFICIAL_OWNER.

{
"account": {
"id": "82c338f4-3cb7-4d9b-be2a-4b077c82ee3a",
"members": [{
"identity_id": "0f5d8475-33f3-4ebd-88a0-66dedc2581c1",
"roles": ["BENEFICIAL_OWNER", "FINANCIAL_ADVISOR"]
}]
}
}

PUT /identity/accounts

Try it

Update Account

cURL

curl --request PUT \
  --url https://api.paxos.com/v2/identity/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "id": "79c27a0e-46a2-4276-9769-e1ebc055fa72",
    "members": [
      {
        "identity_id": "11a3122a-0c50-4950-9934-2ad48a782b78",
        "roles": [
          "FINANCIAL_ADVISOR"
        ]
      },
      {
        "identity_id": "08ba6b70-bcc0-4e4a-a67f-1d28842dedfc",
        "roles": [
          "AUTHORIZED_USER"
        ]
      },
      {
        "identity_id": "2dedfc70-a67f-4e4a-bcc0-1d288408ba6b",
        "roles": [
          "BENEFICIAL_OWNER"
        ]
      }
    ]
  }
}
'

200

{
  "created_at": "2014-02-20T04:22:22.222221Z",
  "id": "79c27a0e-46a2-4276-9769-e1ebc055fa72",
  "identity_id": "0acd56b7-140b-4b29-83e4-7e717f03afd9",
  "members": [
    {
      "identity_id": "11a3122a-0c50-4950-9934-2ad48a782b78",
      "roles": [
        "FINANCIAL_ADVISOR"
      ]
    },
    {
      "identity_id": "08ba6b70-bcc0-4e4a-a67f-1d28842dedfc",
      "roles": [
        "AUTHORIZED_USER"
      ]
    },
    {
      "identity_id": "2dedfc70-a67f-4e4a-bcc0-1d288408ba6b",
      "roles": [
        "BENEFICIAL_OWNER"
      ]
    }
  ],
  "summary_status": "PENDING",
  "updated_at": "2022-02-24T04:20:22.222222Z"
}

OAuth Scope

identity:write_account

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Body

application/json

account · object · required

Show child attributes

account. id · string

The id used for all other interactions with this account.

account. identity_id · string

The primary identity associated with the account.

account. description · string

A free-text description of the account.

account. admin_disabled · boolean

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

account. user_disabled · boolean

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

account. metadata · object

API User-facing metadata.

Show child attributes

account.metadata. {key} · string

account. ref_id · string

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

account. members · object[]

Additional Identities with varying types of access to this account.

Show child attributes

account.members. identity_id · string

account.members. type · enum<string>

Available options: BENEFICIAL_OWNER, AUTHORIZED_USER, FINANCIAL_ADVISOR

account.members. roles · enum<string>[]

Available options: BENEFICIAL_OWNER, AUTHORIZED_USER, FINANCIAL_ADVISOR

account.members. id · string

Account member ID. Note: This field is auto-generated. Specifying an ID when creating an account member is a client error.

account. created_at · string<date-time>

The time this account was created.

account. summary_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

account. updated_at · string<date-time>

The time this account was updated.

account. profile_id · string

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.

account. type · enum<string>

Available options: BROKERAGE, TRADITIONAL_IRA, ROTH_IRA, SEP_IRA, FINANCIAL_ADVISOR

set_user_disabled · boolean

true if the account is required to be disabled by the API user.

Response

200 - application/json

A successful response.

id · string

The id used for all other interactions with this account.

identity_id · string

The primary identity associated with the account.

description · string

A free-text description of the account.

admin_disabled · boolean

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

user_disabled · boolean

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

metadata · object

API User-facing metadata.

Show child attributes

metadata. {key} · string

ref_id · string

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

members · object[]

Additional Identities with varying types of access to this account.

Show child attributes

members. identity_id · string

members. type · enum<string>

Available options: BENEFICIAL_OWNER, AUTHORIZED_USER, FINANCIAL_ADVISOR

members. roles · enum<string>[]

Available options: BENEFICIAL_OWNER, AUTHORIZED_USER, FINANCIAL_ADVISOR

members. id · string

Account member ID. Note: This field is auto-generated. Specifying an ID when creating an account member is a client error.

created_at · string<date-time>

The time this account was created.

summary_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

updated_at · string<date-time>

The time this account was updated.

profile_id · string

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 · enum<string>

Available options: BROKERAGE, TRADITIONAL_IRA, ROTH_IRA, SEP_IRA, FINANCIAL_ADVISOR