Request an account-limit change

post

https://api.checker.finance/v1/payments/customers/{customer_id}/limit-requests

Asks a provider to raise an onboarded individual's account limits. This is stage two of individual onboarding: the customer must already be active at the provider.

The review is asynchronous. A 202 means the request was accepted for review, never that higher limits were granted: the request starts REQUESTED and moves to REVIEWED when the provider finishes its review, carrying the limits in effect afterwards. A review can leave the limits unchanged; compare them with the limits read before the request to see what changed. Poll GET /v1/payments/customers/{customer_id}/limit-requests for the review and GET /v1/payments/customers/{customer_id}/limits for the live values.

An AML/KYC risk profile and supporting documents (SOURCE_OF_FUNDS, PROOF_OF_ADDRESS) are required before the request can be submitted; anything missing is reported together as 422 MISSING_KYC_FIELDS with details.missing. The profile may be supplied inline on this call, or earlier through kyc.risk_profile on customer create/update.

While a request is still REQUESTED, a repeated call returns 200 with the open request and submits nothing, so a retry cannot open a second review.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customer_id

string

required

Body Params

provider

string

required

Provider whose account limits should be reviewed. Required: limits belong to one provider's account, so there is no default.

profile

object

Optional. When supplied, the profile is validated and saved onto the customer's KYC before the request is submitted, so a client can ask for a limit change and supply the supporting profile in one call. When omitted, the stored profile is used.

Headers

Idempotency-Key

string

required

Idempotency key required on all write requests. Replaying the same key with the same body returns the original response.

X-Api-Key

string

required

Your API key

X-Timestamp

string

required

Request timestamp (ISO 8601 UTC), included in the signature payload

X-Nonce

string

required

Unique request nonce (e.g. UUID)

X-Signature

string

required

HMAC-SHA256 hex digest of {METHOD}\n{path}\n{query}\n{X-Timestamp}\n{body}, signed with your API secret. Path excludes the query string; use an empty string for query/body when absent.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A request is already open for this provider. The open request is returned and nothing is submitted.

202Limit request accepted for review

400The customer is not an INDIVIDUAL, is not active at this provider, provider is missing or unknown, or the risk profile contains a value the API does not accept.

401Unauthorized

404Not found

422Required risk-profile fields or documents are missing (MISSING_KYC_FIELDS, with details.missing), or the selected provider does not support account limits (OPERATION_NOT_SUPPORTED).

500Unexpected server error.