Cadastrar documento do portador
Sandbox
https://horizon-api-sb.app.rpe.tech
Sandbox
https://horizon-api-sb.app.rpe.tech
POST
https://horizon-api-sb.app.rpe.tech
PixCard
idRegistroPessoa válido.Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/documento/pessoa/?cpfPessoa&categoriaEnum&detalhesAdicionais' \
--header 'Accept: */*' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZ' \
--form 'file="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAYGBgYHBgc"'Response Response Example
400 - Example 1
{
"timestamp": "2020-01-23T22:10:05.025Z",
"statusCode": 400,
"message": "Bad Request",
"path": "/api/v1/pixcard/pix-out"
}Requisição
Parâmetros Path
idRegistroPessoa
string
requerido
idRegistration).Exemplo:
1
Parâmetros Query
cpfPessoa
string
requerido
Exemplo:
42362009025
categoriaEnum
enum<string>
requerido
DRIVER_LICENSE_FRONT = frente da Carteira Nacional de HabilitaçãoDRIVER_LICENSE_VERSE = verso da Carteira Nacional de HabilitaçãoIDENTITY_CARD_FRONT = frente da Carteira de Identidade NacionalIDENTITY_CARD_VERSE = verso da Carteira de Identidade NacionalSIGNATURE_CARD = carta de assinaturaRNE_FRONT = frente do Registro Nacional de EstrangeirosRNE_VERSE = verso do Registro Nacional de EstrangeirosPASSPORT = passaporteEMANCIPATION_STATEMENT = declaração de emancipaçãoValores permitidos:
DRIVER_LICENSE_FRONTDRIVER_LICENSE_VERSEIDENTITY_CARD_FRONTIDENTITY_CARD_VERSESIGNATURE_CARDSELFIERNE_FRONTRNE_VERSEPASSPORTEMANCIPATION_STATEMENT
Exemplo:
IDENTITY_CARD_FRONT
detalhesAdicionais
boolean
requerido
Padrão:
true
Parâmetros Header
Accept
string
requerido
Exemplo:
*/*
Content-Type
string
opcional
Exemplo:
application/json
Authorization
string
opcional
BearerExemplo:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZ
Parâmetros Bodymultipart/form-data
file
string
opcional
Exemplo:
data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAYGBgYHBgc