Get Pending Documents for Company Registration

GET 
/v1/users/company-registrations/:id/pending-documents

Retrieves the list of pending and uploaded documents for a company registration. This endpoint helps verify which documents are required before uploading.

Request

Path Parameters

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.

Responses

200

Pending documents retrieved successfully.

application/json

Schema

Schema

registration_id stringrequired

Registration ID.

national_registration stringrequired

Company CNPJ.

legal_nature stringrequired

Legal nature code.

status stringrequired

Registration status.

note object

id stringrequired

Note ID.

created stringrequired

Note creation date.

text stringrequired

Note text.

documents objectrequired
uploaded objectrequired
Uploaded documents.
company object[]required
Company documents uploaded.
Array [
id stringrequired
Document ID.
category stringrequired
Document category.
]
individuals object[]required
Individual documents uploaded.
Array [
partner_id string
Partner ID.
]
pending_upload objectrequired
Pending upload documents.
company objectrequired
Pending company documents.
must_have string[]required
Documents that must be uploaded.
at_least_one array[]required
At least one document from each group must be uploaded.
individuals object[]required
Pending individual documents.
Array [
partner_id stringrequired
Partner ID.
profile stringrequired
Partner profile.
type string[]required
Partner types.
must_have string[]required
Documents that must be uploaded.
at_least_one array[]required
At least one document from each group must be uploaded.
]

Example (from schema)

{
  "registration_id": "REG-ABC123DEF456",
  "national_registration": "12345678000190",
  "legal_nature": "2062",
  "status": "PENDING",
  "note": {
    "id": "NOTE-123",
    "created": "2024-01-15T10:30:00.000Z",
    "text": "Additional documents required."
  },
  "documents": {
    "uploaded": {
      "company": [
        {
          "id": "DOC-123456",
          "category": "ARTICLES_OF_ASSOCIATION"
        }
      ],
      "individuals": [
        {
          "partner_id": "PARTNER-123"
        }
      ]
    },
    "pending_upload": {
      "company": {
        "must_have": [
          "ARTICLES_OF_ASSOCIATION",
          "PROOF_OF_ADDRESS"
        ],
        "at_least_one": [
          [
            "CNPJ_CARD",
            "CNPJ_CERTIFICATE"
          ]
        ]
      },
      "individuals": [
        {
          "partner_id": "PARTNER-123",
          "profile": "OWNER",
          "type": [
            "INDIVIDUAL"
          ],
          "must_have": [
            "SELFIE",
            "ID_FRONT"
          ],
          "at_least_one": [
            [
              "CPF",
              "RG"
            ]
          ]
        }
      ]
    }
  }
}

400

If any required parameter is missing or has invalid format/type.

401

User authentication failed.

403

User does not have permission to access this resource.

404

Company registration not found.

422

If any required parameter is missing or has invalid format/type.

Loading...