Obter Documentos Necessários

GET /company/mandatory-documents

Para utilizar esse método, o access_token deve conter o scope company.read

Método utilizado para listar documentos obrigatórios que deverão ser enviados para análise da subconta.

URL da Requisição

https://api.sandbox.cel.cash/v2/company/mandatory-documents

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "Info": {
        "Fields": {
            "name": "valueFiled",
            "description": "descriptionFiled"
        },
        "Associate": [
            {
                "name": "valueFiled",
                "description": "descriptionFiled"
            }
        ],
        "Documents": {
            "Company": {
                "name": "valueFiled",
                "description": "descriptionFiled"
            },
            "Personal": {
                "CNH": [
                    {
                        "name": "valueFiled",
                        "description": "descriptionFiled"
                    }
                ],
                "RG": [
                    {
                        "name": "valueFiled",
                        "description": "descriptionFiled"
                    }
                ]
            }
        }
    }
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

Info

Informações dos campos do documentos obrigatórios.
Clique para ver os campos.

Fields

Campos das informações cadastrais da subconta.
Clique para ver os campos.

name

string 255 caracteres

Nome do campo.

description

text

Descrição do campo.

Associate

Campos dos quadro societário da subconta do tipo CNPJ.
Clique para ver os campos.

name

string 255 caracteres

Nome do campo.

description

text

Descrição do campo.

Documents

Campos dos documentos solicitados da subcontas.
Clique para ver os campos.

Company

CNPJ Tipo Subconta Empresa Documentos em formato base 64.
Clique para ver os campos.

name

string 255 caracteres

Nome do campo.

description

text

Descrição do campo.

Personal

Documentos Pessoais.
Clique para ver os campos.

CNH

Carteira de Habilitação da Subconta no formato base 64.
Clique para ver os campos.

name

string 255 caracteres

Nome do campo.

description

text

Descrição do campo.

Documento de Identidade da Subconta no formato base 64.
Clique para ver os campos.

name

string 255 caracteres

Nome do campo.

description

text

Descrição do campo.

Código

Explicação

200

Sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.