Skip to main content

Request a limit increase

POST 
/v1/compliance/user-limit-requests

Request a limit increase for the end customer identified by the x-product-target-user-uuid header. The request is created OPEN and analyzed by compliance; follow the decision through the user limit request webhooks or the get endpoints. A new increase request for the same limit and period is accepted only 72 hours after the previous one. Retries with the same x-transaction-uuid and the same body return the request already created; reusing it with other data is refused.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Body

required
    limit_type_tag stringrequired

    Limit type tag.

    period_type stringrequired

    Possible values: [DAILY, MONTHLY, YEARLY]

    Limit period to increase.

    requested_value numberrequired

    Possible values: >= 1

    Requested limit value in cents. It is a reference: the approved value can be lower.

    document_type stringrequired

    Possible values: [INCOME_TAX_RETURN, REVENUE_STATEMENT]

    Financial document type: INCOME_TAX_RETURN (last income tax return) for natural person, REVENUE_STATEMENT (last 12 months revenue statement signed by an accountant) for legal person.

    document_file_id stringrequired

    file_id returned by the upload of the document to compliance/user-limit-requests/documents. Each document can be used in a single request.

Responses​

User limit request created.

Schema
    id stringrequired

    User limit request ID.

    status stringrequired

    Possible values: [OPEN, CLOSED]

    Request status. OPEN while it waits for the compliance analysis, CLOSED after the decision.

    analysis_result string

    Possible values: [APPROVED, REJECTED]

    Compliance decision. Only filled after the analysis.

    user_id stringrequired

    End customer the limit belongs to.

    requester_id stringrequired

    User who created the request.

    limit_type_tag stringrequired

    Limit type tag.

    period_type stringrequired

    Possible values: [DAILY, MONTHLY, YEARLY]

    Limit period the request changes.

    requested_value numberrequired

    Requested limit value in cents.

    current_value number

    Limit value in cents in force when the request was created.

    document_type stringrequired

    Possible values: [INCOME_TAX_RETURN, REVENUE_STATEMENT]

    Financial document type attached to the request.

    document_file_id stringrequired

    Storage file ID of the attached financial document.

    created_at date-timerequired

    Request creation date.

    closed_at date-time

    Date the request was closed.

    approved_value number

    Approved limit value in cents. Equal to or lower than the requested value; only filled after approval.

    reason string

    Reason given by compliance for the approval or rejection. Only filled after the decision.

Loading...