Skip to main content

Upload card onboarding document

POST 
/v1/card/onboarding/:id/documents
Tag: api-baas-post-upload-documentDescription: Upload card onboarding document.

Request​

Path Parameters

    id stringrequired

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

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

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

    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.

Body

required
    document_type string

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

    Document type Possible values: selfie,rg_front,rg_verse,cnh_front,cnh_verse,cnh_digital,passport,signature_card,rne_front,rne_verse.

    file binary

    Possible values: [application/pdf, image/jpeg, image/jpg]

    Allowed file formats: application/pdf, image/jpeg, image/jpg.

Responses​

Upload card onboarding document successfully.

Schema
    id stringrequired

    Card Onboarding ID.

    user_id stringrequired

    User ID.

    status objectrequired

    Card Onboarding Status.

    created_at date-timerequired

    Card Onboarding Created At.

    updated_at date-timerequired

    Card Onboarding Updated At.

Loading...