required-fields

Listas campos obrigatórios na operação

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

organization_uuid

string

requerido

Exemplo:

c0b61bfd-0eda-5694-87c3-d049a9684b19

Parâmetros Header

string

opcional

Padrão:

application/json

Content-Type

string

opcional

Padrão:

application/json

Respostas

🟢200Success

application/json

Body

physical

object

requerido

documents

array [array]

requerido

fields

array[string]

requerido

legal

object

requerido

documents

array [array]

requerido

representatives

object

requerido

fields

array[string]

requerido

Exemplo

{
    "physical": {
        "documents": [
            [
                "IDENTITY",
                "DRIVERS_LICENSE"
            ],
            [
                "PICTURE"
            ]
        ],
        "fields": [
            "general_registration_number",
            "general_registration_type",
            "general_registration_organ",
            "general_registration_federal_unit",
            "general_registration_emission",
            "naturalness",
            "nationality"
        ]
    },
    "legal": {
        "documents": [
            [
                "SOCIAL_CONTRACT"
            ]
        ],
        "representatives": {
            "documents": [
                [
                    "IDENTITY",
                    "DRIVERS_LICENSE"
                ],
                [
                    "PICTURE"
                ]
            ]
        },
        "fields": [
            "municipal_registration",
            "state_registration"
        ]
    }
}