Update a legal entity

patch /legalEntities/{id}

Updates a legal entity.

To change the legal entity type, include only the new type in your 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.

Endpoint destination URL

Click to copy

Header parameters

x-requested-verification-code string

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.

Path parameters

id string Required

The unique identifier of the legal entity.

Request parameters

entityAssociations array [object]

List of legal entities associated with the current legal entity. For example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories.

individual object

Information about the individual. Required if type is individual.

organization object

Information about the organization. Required if type is organization.

reference string
Max length: 150

Your reference for the legal entity, maximum 150 characters.

soleProprietorship object

Information about the sole proprietorship. Required if type is soleProprietorship.

type string

The type of legal entity.

Possible values: individual, organization, or soleProprietorship.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy