Skip to main content
An application carries the customer’s account data inline. Cr3dentials screens it and answers with an offer or a decline; the acceptance carries a fresh copy of the data, and final checks run on it.

Application lifecycle

Before acceptance

After acceptance

The diagrams show step values, plus the final status values declined, funded and funding_failed. While an application is open its status is in_progress. An application at prequalified, additional_income or selection can also end as expired (after expires_at) or withdrawn.

Apply

POST /v1/applications with the customer’s consent and account data. Both are required: a missing one answers 400 naming data or consent.

Request fields

string
required
Your id for the customer’s account. Only invited accounts can apply; others are declined with PRG_NOT_INVITED.
reference identifies the consent the customer gave, 1 to 32 characters. granted_at may be at most 5 minutes ahead of our clock. We store both with the decision.
object
required
As held by your platform. phone in international format. account_opened_on, active and kyc_verified feed the account checks.
integer
required
The balance you could hold now. It caps the loan at 80% of what can be held.
array
At least the last 6 full calendar months, both directions. settled_at is null while pending, and a pending transaction never counts as income. transfer_type is one of bank_transfer, card, internal, crypto, other. Inbound rows need payer_name and beneficiary_name; card payments need the merchant fields. intermediary and counterparty_name are accepted but not used today.
array
The last 90 days. kind is one of overdraft, returned_payment, insufficient_funds, negative_balance.
object
required
Credential changes (phone, email, password, two_factor), known devices, and newly added withdrawal destinations, each with its date.
The body is limited to 1 MiB: about 2,500 transactions with every field filled, more when optional fields are left out. A larger body answers 413.

Answers

GET /v1/applications/{id} returns the application view at any time.

Optional: platform income

When offer.income_verification.platforms is not empty, the customer can raise their offer by verifying income from that platform.
1

Start a verification

POST /v1/applications/{id}/income-verification returns verification_id, token, expires_at and platforms.
2

Run it in your app

Pass token to the Cr3dentials SDK’s Zktls.verify(token:). See Mobile SDK.
3

Read the new offer

When the verification finishes, the recalculated offer appears on GET /v1/applications/{id}, and in an offer.updated webhook if you take webhooks.
If the customer declines, call POST /v1/applications/{id}/additional-income/skip. Accepting directly also counts as a skip.

Accept

POST /v1/applications/{id}/acceptance with the customer’s consents and a fresh copy of the same data block.
Request
data’s {} and [] stand for the full objects and lists from Apply. The answer is the application view; once funding starts, its loan is the loan view.

Rules

  • All six consents must be true.
  • data is the block from the application as it stands at acceptance, and it is required.
  • data.customer must be the customer who applied: the same national_id (dots, dashes and spaces don’t matter), or the same full_name when either side has no national_id (case, accents and punctuation don’t matter). Otherwise the answer is 400 naming data.customer, and nothing is funded.
  • amount_cents is any amount from the minimum up to the offer, in steps of US$10.
  • accepted_at is when the customer accepted: at most 5 minutes ahead of our clock and at most 24 hours old.

Answers

Withdraw

POST /v1/applications/{id}/withdraw withdraws an application before funding starts and answers with the application view. Once funding has started it answers 409 INVALID_STATE.