Skip to main content

Revoke Open Finance Enrollment

PATCH 
/open-finance/enrollments/:id/revoke

Revoke an Open Finance enrollment.

Request​

Path Parameters

    id stringrequired

    Enrollment ID.

Header Parameters

    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
    logged_user_document stringrequired

    Document of the user who is revoke the enrollment.

    additional_information string

    Additional information for revoke the enrollment.

Responses​

The enrollment revoked successfully.

Schema
    id stringrequired

    Revoked enrollment id.

    status stringrequired

    Possible values: [PENDING, ERROR, FAILED, AWAITING_DEVICE_RISK_SIGNALS, AWAITING_ACCOUNT_OWNER_VALIDATION, AWAITING_ENROLLMENT, AWAITING_DEVICE_REGISTRATION, PENDING_REVOKE, AUTHORIZED, REVOKED, REJECTED]

    Enrollment status.

    created_at date-timerequired

    Enrollment created at.

    updated_at date-timerequired

    Enrollment updated at.

Loading...