curl --request POST \
--url https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"exclusion-details": {
"end-date": "2024-12-31",
"exclusion-reason": "dismissal",
"extension-plan": false,
"documents": [
{
"document-id": "e079e1ad-bdff-49e9-85f7-fbd228ca15fd",
"document-type": "rescission"
},
{
"document-id": "d9ff0205-76ca-4e6d-b8d5-ff9f85af3f99",
"document-type": "birth-certificate-or-national-id"
},
{
"document-id": "957ef952-8515-4dd6-b356-c1434a8e9f33",
"document-type": "enrollment-request"
}
]
}
}
'{
"request-id": "aaa11111-e89b-12d3-a456-426614174006"
}Exclusão de benefícios primários
Exclui todos os benefícios primários de um membro na empresa-alvo.
POST
/
v1
/
enrollment
/
exclusion
/
{member-tax-id}
curl --request POST \
--url https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"exclusion-details": {
"end-date": "2024-12-31",
"exclusion-reason": "dismissal",
"extension-plan": false,
"documents": [
{
"document-id": "e079e1ad-bdff-49e9-85f7-fbd228ca15fd",
"document-type": "rescission"
},
{
"document-id": "d9ff0205-76ca-4e6d-b8d5-ff9f85af3f99",
"document-type": "birth-certificate-or-national-id"
},
{
"document-id": "957ef952-8515-4dd6-b356-c1434a8e9f33",
"document-type": "enrollment-request"
}
]
}
}
'{
"request-id": "aaa11111-e89b-12d3-a456-426614174006"
}Authorizations
Token Bearer obtido em POST /v1/authenticate.
Path Parameters
CPF do membro. CPF (Cadastro de Pessoas Físicas). Aceita apenas dígitos ou formatado.
Examples:
"12345678900"
"123.456.789-00"
Query Parameters
Resolve automaticamente a movimentação: approve aprova; reject rejeita.
Esta opção existe apenas no ambiente de Homologação, para testes.
Available options:
approve, reject Body
application/json
Show child attributes
Show child attributes
Response
Movimentação processada com sucesso.
Identificador da requisição. Use em GET /v1/request/{request-id}.