Obter recomendações

GET 
/v1/recommendations/:customer

Retorna um array de Recommendations

Request

Path Parameters

customer stringrequired
ID do usuário
Example: cust_5f92f01728e009f403d8502e

Responses

200

Retorna um array de Recommendations para um customer válido.

application/json

Schema

Schema

data

object[]

Uma lista de recomendações

Array [

message string

Mensagem de recomendação

Example: O RH não informou o seu salário. Atualize ou solicite o envio pelo RH para ver o valor disponível para empréstimo.

actions

object[]

Array de objetos contendo as ações recomendadas

Array [

label string

Texto da ação

Example: Atualizar salário

type string

Tipo da ação

Possible values: [refinancing, update_salary]

]

]

Example (from schema)

{
  "data": [
    {
      "message": "O RH não informou o seu salário. Atualize ou solicite o envio pelo RH para ver o valor disponível para empréstimo.",
      "actions": [
        {
          "label": "Atualizar salário",
          "type": "refinancing"
        }
      ]
    }
  ]
}

Loading...