get https://api.stage.cora.com.br/registrations/
Essa API retorna os estados dos clientes que foram indicados por vocês.
Os estados possíveis são:
- Pending: A indicação está pendente, ou seja, a pessoa indicada ainda não se tornou cliente Cora.
- Completed: A indicação foi concluída, ou seja, a pessoa indicada já finalizou o cadastro, se tornou um Cliente Cora e a indicação foi associada a você.
Parâmetros da requisição
| Parâmetro | Tipo | Descrição |
|---|---|---|
| status obrigatório | String | Estado da indicação. |
| start opcional | String | Data do início do intervalo que será filtrado. |
| end opcional | String | Data do fim do intervalo que será filtrado. |
| page opcional | Int | Número da página. |
| perPage opcional | Int | Quantidade por página. |
Parâmetros da resposta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| total_items obrigatório | Objeto PreRegisterTotalItems | Objeto que contém o total de itens pendentes e finalizados. |
| data obrigatório | Objeto PreRegisterData | Objeto que contém o detalhamento da indicação e seu respectivo status. |
Objeto PreRegisterTotalItems
| Parâmetro | Tipo | Descrição |
|---|---|---|
| pending obrigatório | Int | Indicações pendentes, ou seja, que ainda não finalizaram o cadastro ou não foram associadas ao parceiro. |
| completed obrigatório | Int | Indicações completadas, ou seja, a pessoa indicada já finalizou o cadastro e se tornou um cliente Cora. |
| all obrigatório | Int | Somatório dos itens que estão com status pendente e completo. |
Objeto PreRegisterData
| Parâmetro | Tipo | Descrição |
|---|---|---|
| code obrigatório | String | Código definido por você no momento da requisição. Pode ser um id do recurso no seu sistema. |
| person obrigatório | Objeto Owner | Objeto Owner (Detalhes na API de criação de Pré-cadastro). |
| business obrigatório | Objeto Company | Objeto Company (Detalhes na API de criação de Pré-cadastro). |
| last-update obrigatório | String | Data da última modificação desse registro. Pode ser usado para identificar a data da finalização do cadastro do cliente. |
| status obrigatório | String | Indica qual é o status do cliente. Pode ser PENDING ou COMPLETED. |