required-fields

Listar os campos obrigatórios para o cadastro ou atualização de clientes.

Requisição

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Exemplo:

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

Parâmetros Path

organization_uuid

string

requerido

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"
    ]
  }
}