Sign in
Entities

Update Entity

Update a specific customer Entity of your organization.

patch/api/v2/entities/{entity_id}

Request body

reference_idstring nullable

Case sensitive unique reference ID for the Entity. We recommend setting this to the unique ID of the Entity in your system.

Response

OK

idstring uuid required

Unique ID of the Entity.

is_kyc_completeboolean required

Indicates if Entity completed KYC.

entity_type'INDIVIDUAL' | 'ORGANIZATION' required
namestring nullable

Name of Entity.

nationalitystring nullable

Nationality or home country of the Entity.

reference_idstring nullable

Case sensitive unique reference ID that you can set for the Entity. We recommend setting this to the unique ID of the Entity in your system.

Changes

No recorded changes to this endpoint across all 47 revisions of this API.