Base URL:
https://api-control.next.orenda.finance. Access is IP-allowlisted —
contact Orenda support to add your IP or range before you start.Authentication
Get an access token from Cognito, then send it as a bearer token on every call. Orenda supplies yourUSERNAME, PASSWORD, ClientId, and the secret used to compute
SECRET_HASH.
AuthenticationResult.AccessToken is your bearer token (valid ~1 hour;
refresh with the returned RefreshToken).
Create an identity
applicationId you can hand off to onboarding. Unknown fields are ignored.
Request body
| Field | Type | Required | Notes |
|---|---|---|---|
email | string | yes | The identity’s email; the username for Cognito sign-in. |
password | string (min 8) | yes | Initial password. Optional only on programs configured to bypass Cognito. |
firstName | string | yes | |
lastName | string | yes | |
phone | string | conditional | Required when prepaidCardCustomer is true. Also required unless the program uses MFA tokens. |
isCompany | boolean | no | Defaults to false. Must be enabled for your program. |
companyName | string | conditional | Required when isCompany is true. |
prepaidCardCustomer | boolean | no | Selects the managed (program-funded) card flow — see below. |
dateOfBirth | string YYYY-MM-DD | conditional | Required when prepaidCardCustomer is true. |
address | object | conditional | Required when prepaidCardCustomer is true. Fields: country (3-letter ISO), postCode, province, street, town. |
payInIBAN | string | conditional | Required when prepaidCardCustomer is true and the program requires a pay-in IBAN. |
clientReference | string (≤36) | no | Your own reference. On bypass-Cognito programs it becomes the identity. |
accountProviderHolderId | string | no | Pre-existing provider holder id, if any. |
Response
{ "success": false, "error_code": "…" }: 422 for a missing body or
validation failure (error_code is MISSING_BODY, VALIDATION_FAILED, or the specific
field message); 400 / 401 / 500 carry CONTACT_SUPPORT.
Managed vs. default cards
TheprepaidCardCustomer flag is the fork that decides how the user’s card is funded.
prepaidCardCustomer: true — Managed | prepaidCardCustomer: false (or omitted) — Default | |
|---|---|---|
| Use case | Program funds the card on the user’s behalf | User funds their own card via IBAN |
| Funding | Program master account via Load / Unload | User’s assigned IBAN |
| Extra required fields | phone, dateOfBirth, address (+ payInIBAN on some programs) | none beyond the base fields |
| Onboarding | Risk is auto-completed; identity verification (Sumsub) still runs on most programs | Full onboarding (KYC + Sumsub) |
Program configuration varies (whether Cognito is bypassed, whether a pay-in IBAN is
required, whether a Sumsub applicant is created for prepaid customers, individual vs.
company sign-up). Confirm your program’s setup with Orenda.
What happens next
POST /identity only creates the user and application. The rest of the journey — sign-in,
legal agreements, KYC, identity verification, and ordering the card — runs on the
Customer API with the user’s token. See
Issuing cards for your users for the end-to-end walkthrough.