Obter informações do Auxílio emergencial pelo documento.

Em desenvolvimento

Prod Env

https://api.klever.tec.br/api

GET

/v2/ondemand/persons/{document}/emergency-aid

Retorna as informações do Auxílio emergencial associadas ao documento (CPF) fornecido. Retorna um código de status HTTP 200 (OK) se a consulta for bem-sucedida.

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

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Informações do Auxílio emergencial obtidas com sucesso.

application/json

Body

Exemplo

{
    "document": "string",
    "id": "string",
    "modified": "2019-08-24T14:15:22Z",
    "records": [
        {
            "amount": 0,
            "availabilityMonth": "string",
            "beneficiary": {
                "formattedCpf": "string",
                "name": "string",
                "nis": "string"
            },
            "emergencyAidFraming": "string",
            "emergencyAidResponsible": {
                "formattedCpf": "string",
                "name": "string",
                "nis": "string"
            },
            "emergencyAidSituation": "string",
            "id": 0,
            "installmentNumber": "string",
            "municipality": {
                "country": "string",
                "ibgeCode": "string",
                "ibgeName": "string",
                "regionCode": "string",
                "regionName": "string",
                "uf": {
                    "acronym": "string",
                    "name": "string"
                }
            }
        }
    ]
}

Modificado em 2024-10-09 20:26:49

Página anterior

Atualizar dados do Auxílio emergencial pelo documento.

Próxima página

Obter Bolsa Família da pessoa pelo documento.