Add Institution Members

Add one or more institution members to a given institution.

Adding new members doesn’t affect existing members. For example, if an institution has three members, and adds two members using this API, then the institution would end up with five total members.

For details on the properties that can be specified when creating institution members, see Specifying Institution Members and Their Roles.

POST /identity/institution-members

Add Institution Members

cURL

curl --request POST \
  --url https://api.paxos.com/v2/identity/institution-members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "institution_id": "2908fa8b-427a-4089-b2cf-17654c604623",
  "members": [
    {
      "identity_id": "31abdcbd-2801-4dbc-8986-adec3828391b",
      "roles": [
        "GRANTOR"
      ]
    },
    {
      "identity_id": "58def33e-b68f-47d3-bc2b-62b1f68f21e5",
      "roles": [
        "TRUSTEE"
      ]
    }
  ]
}
'

200

{
  "institution_id": "2908fa8b-427a-4089-b2cf-17654c604623",
  "members": [
    {
      "identity_id": "31abdcbd-2801-4dbc-8986-adec3828391b",
      "roles": [
        "GRANTOR"
      ],
      "id": "23ebbcd3-0fe6-48c8-9a2c-a35572b0e8ba"
    },
    {
      "identity_id": "58def33e-b68f-47d3-bc2b-62b1f68f21e5",
      "roles": [
        "TRUSTEE"
      ],
      "id": "a0a0d270-0dd1-40b7-85ce-de713c47bcec"
    }
  ]
}

OAuth Scope

identity:write_identity

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

institution_id · string · required

ID of institution identity to which members will be added.

members · object[] · required

A non-empty array of institution members to be added.

Show child attributes

Response

200 - application/json

A successful response.

institution_id · string

ID of institution identity to which members were added.

members · object[]

List of institution members that were added to the institution.

Show child attributes