Skip to main content

Upload Company Biometric Document

POST 
/v1/users/company-registrations/:company_registration_id/documents

Submit a document for company registration using multipart/form-data to submit an image file. Use the Get Pending Documents endpoint to check which documents are required.

Request​

Path Parameters

    company_registration_id stringrequired

    Company registration 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.

Body

required

Submit document using multipart/form-data.

    category stringrequired

    Possible values: [SELFIE, DRIVER_LICENSE_FRONT, DRIVER_LICENSE_VERSE, IDENTITY_CARD_FRONT, IDENTITY_CARD_VERSE, RNE_FRONT, RNE_VERSE, PASSPORT]

    Document category.

    file binaryrequired

    Document file. Formats: image/jpeg, image/jpg, image/png, application/pdf. Max: 25MB.

Responses​

Document submitted successfully.

Schema
    id stringrequired

    Document ID.

    company_registration_id stringrequired

    Company registration ID.

    category stringrequired

    Possible values: [SELFIE, DRIVER_LICENSE_FRONT, DRIVER_LICENSE_VERSE, IDENTITY_CARD_FRONT, IDENTITY_CARD_VERSE, RNE_FRONT, RNE_VERSE, PASSPORT]

    Document category.

    status stringrequired

    Possible values: [PENDING, READY, FAILED]

    Processing status. PENDING: Document submitted and being processed. READY: Document processed successfully. FAILED: Document processing failed.

    created_at date-timerequired

    Document creation date.

    updated_at date-timerequired

    Document last update date.

Loading...