Skip to main content
POST
Create a user

Authorizations

X-Signature
string
header
required

HMAC signature authentication for backend integrators.

Required Headers:

  • X-Integrator-Key: Integrator API key (format: ik_...)
  • X-Signature: HMAC signature (format: sha256={hex})
  • X-Timestamp: Unix timestamp in milliseconds
  • Authorization: Bearer {user-api-key}

Signature Algorithm: HMAC-SHA256

Signature Format: {timestamp}.{METHOD}.{path}.{bodyHash}

  • timestamp: Unix timestamp in milliseconds
  • METHOD: HTTP method in UPPERCASE (GET, POST, etc.)
  • path: Request path (e.g., /v1/transactions)
  • bodyHash: SHA256 hex digest of request body (empty string if no body)

Timestamp Tolerance: ±5 minutes (300 seconds)

Example: For POST /v1/transactions with body {"amount":100} and timestamp 1234567890000: Payload: 1234567890000.POST./v1/transactions.{sha256(body)} Signature: sha256=abc123...

X-Integrator-Key
string
header
required

Integrator API key (format: ik_...) used with HMAC authentication

X-Timestamp
string
header
required

Unix timestamp in milliseconds for request freshness. Must be within 5 minutes of server time. The timestamp alone bounds but does not prevent an exact replay within that window. Use Idempotency-Key on supported mutations.

Body

email
string<email>
required

Email address of the account to create or, where account reuse is enabled, to reuse. Matched after trimming and lowercasing; dots and plus suffixes are significant.

Example:

"user@example.com"

timezone
string

IANA timezone identifier for an account this call creates. Ignored when the call reuses an existing account.

Example:

"America/New_York"

Response

Response for status 200

userId
string
required

ID of the account this request resolved to: the account it created or, where account reuse is enabled, the existing account this email resolves to for you (your own, or one you are currently authorized for through an existing authorization). With reuse enabled, a repeat for the same email returns the same ID.

Example:

"6afe8ef84a39e77f8f7add1b"

email
string<email>
required

The account's current email address.

Example:

"user@example.com"

apiKey
string
required

A freshly minted API key (ak_...) for this account, bound to your integrator. Every accepted call returns a new key and older keys may stay valid until revoked. Returned only in this response - store it securely.

Example:

"ak_N2FjZTk3ZjMtsTWiZF00MGU0LWIxYTMtMTY0ZmM3MzJiNTdm"