Skip to main content

Get Legal Representative Document by ID

GET 
/v1/users/legal-representatives/:id/documents/:doc_id

Get a specific legal representative document by ID related to the logged user.

Request​

Path Parameters

    id stringrequired

    Legal representative ID.

    doc_id stringrequired

    Document 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

    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​

The legal representative document returned successfully.

Schema
    id stringrequired

    Legal representative document ID.

    file_id objectrequired

    Legal representative document file ID.

    file_name objectrequired

    Legal representative document file name.

    created_at objectrequired

    Legal representative document file created at.

    updated_at date-time

    Legal representative document file updated at.

    type stringrequired

    Possible values: [selfie, identity_document, qualification_declaration, income_declaration, address_proof]

    Legal representative document type.

    identity_document_type string

    Possible values: [id, cnh, passaporte]

    Identity document subtype (id, cnh, passaporte). Only for identity_document.

Loading...