Skip to main content
POST
Create benefiting person

Authorizations

Authorization
string
header
required

Bearer access token from POST /api/auth

Headers

X-Idempotency-Key
string
required

Unique key for safe retries. Max 128 characters.

Required string length: 1 - 128

Path Parameters

accountId
string<uuid>
required

accountId identifier

Body

application/json
firstname
string
required
Required string length: 1 - 100
lastname
string
required
Required string length: 1 - 100
street
string
required
Required string length: 1 - 200
zip
string
required
Required string length: 1 - 20
state
string
required
Required string length: 1 - 100
city
string
required
Required string length: 1 - 100
country
string
required

ISO 3166-1 alpha-2 country code (A2), e.g. DE, US.

Required string length: 2

Response

Created

id
string<uuid>
required
firstname
string
required
lastname
string
required
street
string
required
zip
string
required
state
string
required
city
string
required
country
string
required