Skip to main content

Get Company Registration Pending Documents

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

Returns the authoritative list of pending and already uploaded company-registration documents after provider registration exists, grouped by legal person and legal representatives.

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

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses​

Company registration pending and uploaded documents retrieved successfully.

Schema
    subjects object[]required

    Authoritative document status grouped by legal person and legal representatives.

  • Array [
    • legal_representative_id objectnullable

    Legal representative ID.

    type stringrequired

    Possible values: [COMPANY, LEGAL_REPRESENTATIVE]

    Subject type for document rules.

    uploaded string[]required

    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.

    required string[]required

    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.

    one_of array[]required

    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.

  • ]
Loading...