v2

latestOpenAPI 3.0.22026-08-081303782.1 MB
Identities

Update an Identity

Update an existing Identity.

If you are updating the Identity of a Merchant that’s already been onboarded, you need to verify the merchant again.

put/identities/{identity_id}

Request body

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Response

Single Identity object

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

applicationstring

ID of the Application associated with the resource.

identity_rolesstring[]

The set of roles available to the Identity. If none is provided, the Identity will be assigned BUYER.

type'PERSONAL' | 'BUSINESS'

The Identity type.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)