v1

latestOpenAPI 3.1.02026-07-202961265.4 KB
Legal entities

Update a legal entity

Updates a legal entity.

To change the legal entity type, include only the new type in your request.

If you need to update information for the legal entity, make a separate request. To update the entityAssociations array, you need to replace the entire array.For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.

Requests to this endpoint are subject to rate limits:

  • Live environments: 700 requests per 5 seconds.

  • Test environments: 200 requests per 5 seconds.

  • Failed requests are subject to a limit of 5 failures per 10 seconds.

patch/legalEntities/{id}

Path parameters

idstring required

The unique identifier of the legal entity.

Headers

x-requested-verification-codestring

Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.

Request body

capabilitiesobject

Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, issueCard for Issuing. The value is an object containing the settings for the capability.

referencestring

Your reference for the legal entity, maximum 150 characters.

type'individual' | 'organization'

The type of legal entity.

Possible values: individual or organization

verificationPlanstring

A key-value pair that specifies the verification process for a legal entity. Set to upfront for upfront verification for marketplaces.

Response

OK - the request has succeeded.

capabilitiesobject

Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, issueCard for Issuing. The value is an object containing the settings for the capability.

idstring required

The unique identifier of the legal entity.

referencestring

Your reference for the legal entity, maximum 150 characters.

type'individual' | 'organization'

The type of legal entity.

Possible values: individual or organization

verificationPlanstring

A key-value pair that specifies the verification process for a legal entity. Set to upfront for upfront verification for marketplaces.