Substituir documento reprovado ou expirado

POST

/api/ContaDigital/AlterarDocumento

ContaDigital

Funcionalidade principal

O endpoint AlterarDocumento permite substituir um documento existente por uma nova versão. Ele associa o novo arquivo (enviado em Base64) ao registro histórico do cliente, invalidando a versão anterior e disparando uma nova análise pelo sistema.

Casos de uso comuns

Correção de erro de análise: O documento anterior foi rejeitado por "foto ilegível", e o usuário precisa reenviar uma foto melhor.

Atualização cadastral: O cliente mudou de endereço e precisa substituir o comprovante de residência antigo por um atual.

Renovação de documento expirado: Substituição de um RG antigo por uma CNH nova ou Passaporte dentro do prazo de validade.

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/AlterarDocumento' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0,
        "TipoDocumentoAntigo": 0,
        "CodigoDocumentoAntigo": 0,
        "DocumentoNovo": {
            "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:02:25

Página anterior

Verificar inventário e pendências de documentos

Próxima página

Consultar status dos documentos

Substituir documento reprovado ou expirado

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns