Skip to main content

Get Client Pendency by ID

GET 
/v1/crossborder/client-pendencies/:id

Retrieve a client pendency by its unique identifier, including its current item.

Request​

Path Parameters

    id stringrequired

    Client pendency ID.

Header Parameters

    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.

    x-wallet-uuid string

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

Responses​

Client pendency returned successfully.

Schema
    id stringrequired

    Client pendency ID.

    client_id stringrequired

    Client ID.

    status stringrequired

    Possible values: [PENDING, IN_ANALYSIS, APPROVED, REJECTED]

    Request status.

    criticality stringrequired

    Possible values: [LOW, HIGH]

    Request criticality.

    document_type stringrequired

    Possible values: [IDENTITY_CARD, DRIVERS_LICENSE, PASSPORT, FOREIGNER_ID, MILITARY_ID, PROFESSIONAL_ID, WORK_CARD, BIRTH_CERTIFICATE, MARRIAGE_CERTIFICATE, SELFIE, SIGNATURE_CARD, PROOF_OF_ADDRESS, BANK_STATEMENT, PROOF_OF_INCOME, TAX_STATEMENT, ARTICLES_OF_ASSOCIATION, COMPANY_BYLAWS, INCORPORATION_STATEMENT, POWER_OF_ATTORNEY, LEGAL_STATEMENT, CONTRACT, INVOICE, SOURCE_OF_FUNDS_DECLARATION, PEP_DECLARATION, SANCTIONS_SCREENING_REPORT, OTHER]

    Requested document type.

    document_category stringrequired

    Possible values: [IDENTIFICATION, ADDRESS, FINANCIAL, CORPORATE, COMPLIANCE, OTHER]

    Document category.

    compliance_comment string

    Compliance's comment on the current item.

    client_comment string

    Client's own comment on the current item.

    created_at date-timerequired

    Creation date.

    updated_at date-timerequired

    Update date.

    documents object[]required

    Documents linked to this pendency current item, if any.

  • Array [
    • id stringrequired

    Client document ID.

    name stringrequired

    Document name.

    description string

    Document description.

    type stringrequired

    Possible values: [IDENTITY, PROOF_OF_ADDRESS, BANK_STATEMENT, INVOICE, CONTRACT, OTHER]

    Document type.

    file_id string

    File ID.

    created_at date-timerequired

    Creation date.

  • ]
Loading...