Sign in
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.

Changes

Changed in 15 of the 50 revisions of this API.162153

  • v1c60ff828fc912See the full diff
    • ○

      the request optional property capabilities became not read-only

      request-optional-property-became-not-read-only

    • ○

      the response optional property capabilities became not read-only for the status 200

      response-optional-property-became-not-read-only

  • v1baaa283465dc2See the full diff
    • ○

      added the new optional request property entityAssociations/items/nominee

      new-optional-request-property

    • ○

      added the optional property entityAssociations/items/nominee to the response with the 200 status

      response-optional-property-added

  • v1aca4e2aa4c212See the full diff
    • ○

      the request optional property unincorporatedPartnership/type became read-only

      request-optional-property-became-read-only

    • ○

      the response optional property unincorporatedPartnership/type became read-only for the status 200

      response-optional-property-became-read-only

  • v1c56db900a96088See the full diff
    • ●

      added the new issueChargeCard enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueChargeCard enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueChargeCardCommercial enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueChargeCardCommercial enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCard enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCard enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCardCommercial enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCardCommercial enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new issueChargeCard enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueChargeCard enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueChargeCardCommercial enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueChargeCardCommercial enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCard enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCard enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCardCommercial enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCardCommercial enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

  • v1fafc3fa6c3022See the full diff
    • ○

      the request optional property entityAssociations/items/settlorExemptionReason became not read-only

      request-optional-property-became-not-read-only

    • ○

      the response optional property entityAssociations/items/settlorExemptionReason became not read-only for the status 200

      response-optional-property-became-not-read-only

  • v1cb8cf81c9fdf13See the full diff
    • ●

      added the new secondaryPartner enum value to the entityAssociations/items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property unincorporatedPartnership

      new-optional-request-property

    • ○

      added the new secondaryPartner enum value to the request property entityAssociations/items/type

      request-property-enum-value-added

    • ○

      added the optional property unincorporatedPartnership to the response with the 200 status

      response-optional-property-added

  • v117f58f130da444See the full diff
    • ●

      added the new businessTrust enum value to the trust/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new charitableTrust enum value to the trust/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new discretionaryTrust enum value to the trust/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new familyTrust enum value to the trust/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new businessTrust enum value to the request property trust/type

      request-property-enum-value-added

    • ○

      added the new charitableTrust enum value to the request property trust/type

      request-property-enum-value-added

    • ○

      added the new discretionaryTrust enum value to the request property trust/type

      request-property-enum-value-added

    • ○

      added the new familyTrust enum value to the request property trust/type

      request-property-enum-value-added

  • v1899845dae6cc22See the full diff
    • ●

      added the new issueCreditLimit enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueCreditLimit enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new issueCreditLimit enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueCreditLimit enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

  • v102e81068c2d82See the full diff
    • ○

      added the new optional request property entityAssociations/items/relationship

      new-optional-request-property

    • ○

      added the optional property entityAssociations/items/relationship to the response with the 200 status

      response-optional-property-added

  • v1ce7ace361e761See the full diff
    • ○

      the endpoint scheme security clientKey was removed from the API

      api-security-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog