Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string

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.

Body

application/json

Account holder parameters

account_program_id
string<uuid>
required

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

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
beneficiary_data
object
required

Personal information of the account holder.

Response

200 - application/json

Account holder created successfully

id
string
required

Unique identifier of the account holder.

Pattern: ^[0-9a-fA-F]{24}$
type
enum<string>
required

Resource type discriminator.

Available options:
account_holder
status
enum<string>
required

Current account holder status.

Available options:
pending,
active,
closed
beneficiary_data
object
required

Beneficiary details used to create this account holder.

created_at
string<date-time>
required

ISO 8601 UTC timestamp when the account holder was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$