Skip to main content

Upload Company Document

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

Submit a company document for registration using multipart/form-data to submit a document 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: [CCMEI, PRIVATE_LETTER_OF_ATTORNEY, ARTICLES_OF_ASSOCIATION, COMPANY_BYLAWS, PUBLIC_LETTER_OF_ATTORNEY, LEGAL_STATEMENT, EIRELI_INCORPORATION_STATEMENT, EI_REGISTRATION_REQUIREMENT, DRIVER_LICENSE_FRONT, DRIVER_LICENSE_VERSE, DIGITAL_DRIVER_LICENSE, IDENTITY_CARD_FRONT, IDENTITY_CARD_VERSE, WORK_CARD, PROFESSIONAL_IDENTIFICATION_CARD, MILITARY_IDENTIFICATION_CARD, REVENUES_RECEIPT, SIGNATURE_CARD, SELFIE, EXTRAORDINARY_DOCUMENTS, RNE_VERSE, RNE_FRONT]

    Document category.

    legal_representative_id uuidnullable

    Legal representative ID for representative document categories.

    file binaryrequired

    Document file. Formats: application/pdf, image/jpeg, image/jpg. Max size is configured by APP_COMPANY_DOCUMENT_MAX_FILE_SIZE_BYTES (default: 4.5MB).

Responses​

Document submitted successfully.

Schema
    id stringrequired

    Document ID.

    company_registration_id stringrequired

    Company registration ID.

    category stringrequired

    Possible values: [CCMEI, PRIVATE_LETTER_OF_ATTORNEY, ARTICLES_OF_ASSOCIATION, COMPANY_BYLAWS, PUBLIC_LETTER_OF_ATTORNEY, LEGAL_STATEMENT, EIRELI_INCORPORATION_STATEMENT, EI_REGISTRATION_REQUIREMENT, DRIVER_LICENSE_FRONT, DRIVER_LICENSE_VERSE, DIGITAL_DRIVER_LICENSE, IDENTITY_CARD_FRONT, IDENTITY_CARD_VERSE, WORK_CARD, PROFESSIONAL_IDENTIFICATION_CARD, MILITARY_IDENTIFICATION_CARD, REVENUES_RECEIPT, SIGNATURE_CARD, SELFIE, EXTRAORDINARY_DOCUMENTS, RNE_VERSE, RNE_FRONT]

    Document category.

    legal_representative_id stringnullable

    Legal representative ID used for representative documents when provided.

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