Account Holders

Create account holder

Creates a new account holder and starts asynchronous processing.

post/v1/account_holders

Headers

Idempotency-Keystring required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

account_program_idstring uuid required

ID of the account program to create the account holder under.

holder_type'natural_person' | 'business' required

Type of the account holder.

Response

Account holder created successfully

idstring required

Unique identifier of the account holder.

type'account_holder' required

Resource type discriminator.

holder_type'natural_person' | 'business' required

Type of the account holder.

status'pending' | 'active' | 'closed' required

Current account holder status.

created_atstring date-time required

ISO 8601 UTC timestamp when the account holder was created.

Changes

Changed in 2 of the 30 revisions of this API.24

  • 1d6de495a31d23See the full diff
    • added the new required request property holder_type

      new-required-request-property

    • the header request parameter Idempotency-Key became required

      request-parameter-became-required

    • added BusinessBeneficiaryData to the beneficiary_data request property anyOf list

      request-property-any-of-added

    • added BusinessBeneficiaryDataResponse to the beneficiary_data response property anyOf list for the response status 200

      response-property-any-of-added

    • added the required property holder_type to the response with the 200 status

      response-required-property-added

    • endpoint added

      endpoint-added