Skip to main content
POST
Register Senders

Authorizations

x-api-key
string
header
required

API key for authentication

Authorization
string
header
required

ES256 JWT signed by the private key registered to the API key above. Claims: sub (=API key), uri, nbf, iat, exp, and bodyHash (HMAC-SHA512 of uri + rawBody + nbf using a shared secret, base64).

Body

application/json
senders
object[]
required
Minimum array length: 1

Response

Senders registered

id
string<uuid>
required
profile_type
enum<string>
required
Available options:
enterprise,
individual
country_code
string
required
status
enum<string>
required

Starts pending. No client action moves it — resolves automatically once asynchronous partner KYC/KYB review completes.

Available options:
pending,
ready,
rejected
created_at
string<date-time>
required
updated_at
string<date-time>
required
registration_number
string | null
address
string | null
contact_email
string | null
contact_phone
string | null
status_reason
string | null

Present only when status is rejected.