Fazer upload de documentos de identificação

POST

/api/ContaDigital/IncluirDocumento

ContaDigital

Funcionalidade principal

O endpoint IncluirDocumento permite o upload de arquivos de identificação e comprovantes. Ele associa arquivos em formato Base64 ao cadastro de um cliente específico sob um canal, suportando múltiplos documentos em uma única chamada.

Casos de uso comuns

Abertura de conta: Envio de fotos da CNH ou RG (frente e verso) e Selfie.

Comprovação de endereço: Upload de contas de consumo (luz, água) para validação de residência.

Contas PJ: Envio de Contrato Social, Estatuto ou Atas de Nomeação.

Regularização: Envio de novos documentos após uma reprovação na análise inicial.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

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

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/ContaDigital/IncluirDocumento' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0,
        "RgCnhPossuiNumeroCpf": true,
        "CodigoRetorno": 0,
        "ListaDocumentos": [
            {
                "TipoDocumento": 0,
                "NomeArquivo": "string",
                "FormatoArquivo": "string",
                "Base64Arquivo": "string",
                "GrauParentescoTitular": "string"
            }
        ]
    }
}'

Response Example

{
    "Data": [
        {
            "TipoDocumento": 0,
            "NomeArquivo": "string",
            "CodigoDocumento": 0
        }
    ],
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:01:40

Página anterior

Listar novos clientes ativados por período

Próxima página

Verificar inventário e pendências de documentos

Fazer upload de documentos de identificação

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns