Listar empresas documentos
Lista as empresas conveniadas à Ezpay Business que o CPF informado possui documentos na plataforma.
info
São retornadas empresas emissoras mesmo se o CPF não possuir opt-in.
Interface
Método HTTP | Endpoint |
---|---|
GET | https://api.ez-pay.app/v1/list_user_companies |
Parâmetros de entrada
Header |
---|
Bearer token |
Query Params | |
---|---|
Parâmetro | Tipo |
cpf | STRING(11) CPF do cliente que deseja consultar |
Response
{
"data": [
{
"cnpj": "12345678912345",
"id_emissora": "23fa7559-ac39-448d-ba23-6e301826015f",
"logotipo": "https://logotipo.com/public/logos/imagem.png",
"nome_empresarial": "Empresa Emissora A",
"segmento": "Telefonia Móvel"
}
],
"message": "Requisição processada com sucesso",
"trackid": "d41dcaf1-e98b-408f-bd89-b47eeddbced8"
}
Mensagens
Código HTTP | Mensagem |
---|---|
200 | Requisição processada com sucesso |
204 | CPF não possui opt-in |
204 | Emissora inexistente |
400 | Parâmetros inválidos |
400 | CPF inválido |
401 | Credential unexpected |
500 | Erro ao processar a requisição |