Cadastrar documento do portador

Sandbox

https://horizon-api-sb.app.rpe.tech

POST

/api/v1/pixcard/contas/pessoas/{idRegistroPessoa}/documento

Use este endpoint para cadastrar um documento da pessoa portadora.

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

Parâmetros Query

Parâmetros Header

Parâmetros Bodymultipart/form-data

Respostas

🟢200OK

application/json

Novo arquivo cadastrado

Body

🟢201Criado

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/contas/pessoas//documento?categoriaEnum&additionalDetails' \
--header 'Accept: */*' \
--header 'Authorization: Bearer <token>' \
--form 'file=""'

Response Example

200 - Exemplo 1

{
    "message": "Documento cadastrado",
    "result": {
        "category": "PASSPORT",
        "idDocument": "21312324",
        "created": "Documento criado"
    }
}

Página anterior

Cadastrar termo obrigatório

Próxima página

Criar uma conta digital