Skip to main content
POST
banking.user.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
endUserId
string
required

Your own user ID. Use an opaque ID, never an email, phone number or government identifier.

Required string length: 1 - 128
identity
object

Optional consented name, birth date, contact details and government identity numbers.

Response

The result

ref
string

Reference to what this call created. Pass it as ref to banking.user.get and banking.user.delete.