Get Company Registration Pending Documents
GET/v1/users/company-registrations/:id/pending-documents
Returns pending and already uploaded documents for the company registration, grouped by subject.
Request
Path Parameters
Company registration ID.
Header Parameters
The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.
Possible values: [pt-BR, en-US]
Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.
The product ID is a UUID (v4) used to identify the Z.ro product configuration.
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
- 200
- 400
- 401
- 403
- 422
Company registration pending and uploaded documents retrieved successfully.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
subjects object[]required
Document status grouped by subject (company and legal representatives).
Legal representative ID.
Possible values: [COMPANY, LEGAL_REPRESENTATIVE]
Subject type for document rules.
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]
Uploaded document categories for this subject.
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]
Pending required document categories for this subject.
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]
Pending groups where at least one category from each group must be uploaded.
{
"subjects": [
{
"legal_representative_id": "8fc58500-b12e-49d7-892c-dfd704b94c2d",
"type": "COMPANY",
"uploaded": [
"ARTICLES_OF_ASSOCIATION",
"REVENUES_RECEIPT"
],
"required": [
"CCMEI"
],
"one_of": [
[
"CCMEI",
"ARTICLES_OF_ASSOCIATION"
]
]
}
]
}
If any required parameter is missing or has invalid format/type.
User authentication failed.
User does not have permission to access this resource.
If any required parameter is missing or has invalid format/type.