/api/v1/bank-link
Mint a bank-verification portal link for an existing case.
- Scope
bank_link:write- Rate limit
- 100 requests / min
- Idempotency
Idempotency-Keysupported
Authentication
Send your key as Authorization: Bearer …. It must carry the scope bank_link:write; a key without it receives 403 forbidden.
Headers
Idempotency-KeystringReplays the first response for a repeated request. Reusing a key with a different body is idempotency_key_reused (409), never a silent replay.
Request body
application/jsonrequiredcase_idstringrequiredmin length 1The case to mint the link for, as returned by POST /v1/underwrite.
Refused parameters4
Sending any of these returns 400 validation_error naming the field. Each entry explains what to do instead.
applicant_email'applicant_email' is not accepted: the link is delivered to the applicant email on the case record.
applicant_phone'applicant_phone' is not accepted: SMS delivery is not available.
redirect_url'redirect_url' is not accepted: post-connection redirects are not available.
expires_in'expires_in' is not accepted: links expire 7 days after creation.
Response
201application/jsonSerializedBankLinkidstringrequiredcase_idstringrequiredstatusstringrequiredurlstringrequiredexpires_atstring | nullrequirednullableErrors
The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.
400validation_error401unauthorized403forbidden404not_found409idempotency_key_reused429rate_limit_exceeded500internal_error