Skip to main content

Get Card Onboarding By ID

GET 
/card/onboarding/:id
Tag: api-users-get-card-onboarding-by-idDescription: Get card onboarding by ID.

Request​

Path Parameters

    id stringrequired

    Card Onboarding 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-lang string

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

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

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Get card onboarding by ID.

Schema
    id stringrequired

    Card Onboarding ID.

    user_id stringrequired

    User ID.

    birth_date date-timerequired

    Bith Date.

    document stringrequired

    Document (CPF).

    mother_name stringrequired

    Mother Name.

    name stringrequired

    Name.

    pep booleanrequired

    Is PEP.

    pep_since stringrequired

    Is PEP Since.

    status objectrequired

    Card Onboarding Status.

    address objectrequired
    id objectrequired

    User address ID.

    zip_code objectrequired

    User address zip code.

    street objectrequired

    User address street.

    number objectrequired

    User address number.

    neighborhood object

    User address neighborhood.

    city objectrequired

    User address neighborhood.

    federative_unit objectrequired

    User address federative unit.

    country objectrequired

    User address country.

    complement object

    User address complement.

    documents object[]

    User card onboarding documents.

  • Array [
    • id objectrequired

    Card Onboarding Document ID.

    card_onboarding_id objectrequired

    Card Onboarding ID.

    file_id objectrequired

    File ID.

    type stringrequired

    Possible values: [selfie, rg_front, rg_verse, cnh_front, cnh_verse, cnh_digital, passport, signature_card, rne_front, rne_verse]

    Card Onboarding Document Type.

    created_at objectrequired

    Card Onboarding Document Created At.

    updated_at objectrequired

    Card Onboarding Document Updated At.

  • ]
    • created_at date-timerequired

    Card Onboarding Created At.

    updated_at date-timerequired

    Card Onboarding Updated At.

Loading...