Skip to navigation
API Internet BankingAccounts

Submit a limit request for review

Moves awaiting_documents to pending_review when every required document is APPROVED. From info_requested, every type the reviewer asked for needs an approved file uploaded after that message. When no type was asked, a text reply is enough. Sends limit_request.updated with reason: submitted.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.
requestIdstringRequired
Limit request id.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-Acting-DocumentstringOptional
CPF of the human performing the operation. Required on cashout routes when the credential enforces a transaction PIN.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Response

Request is now pending review.
idstring
statusenum

awaiting_documents is outside the queue until submit. info_requested means the reviewer asked for more and the 7-day window restarted.

operationenum
Allowed values:
windowenum
Allowed values:
currentLimitBrldouble

Effective ceiling when the request was opened, including a previous-register (legacy) ceiling. 0 only when that window was open (no ceiling).

requestedLimitBrldouble
justificationstring
identifierstring
createdAtdatetime
approvedLimitBrldouble or nullOptional

Ceiling actually applied. Null until approval. May differ from requestedLimitBrl when the reviewer adjusts it.

decisionMessagestring or nullOptional
effectiveAtdatetime or nullOptional
When the new ceiling starts. Null means it was applied immediately.
documentsDueAtdatetime or nullOptional
Deadline to submit documents or the reply to an information request. Null on requests opened before this field existed.
submittedAtdatetime or nullOptional
When the holder submitted the request into the review queue.

Errors

409
Conflict Error
422
Unprocessable Entity Error