API to send the NIP
Intro
With this API you will carry out step 1 for the authentication process to the SICs (Buró de crédito and Círculo de Crédito).
With this API, a 6-digit NIP code will be sent to the client so that you can authenticate their query.
Important points
Body
It is not necessary to send a query body, because the required fields are obtained from the form, so you only need to have your workfloo configured with the required fields.
Kiban will send the following fixed messages.
- For email:
Email message
Hola {{firstName}}
Tu NIP para validar la creación de tu cuenta y autorizar la consulta del Reporte de Crédito {{company_name}} es:
{{NIP}}Atentamente,
El equipo kiban
- For SMS
The message defined in the NIP connector configuration in workfloo will be sent.
- For WhatsApp:
WhatsApp message
Tu NIP para crear tu cuenta y autorizar la consulta del Reporte de Crédito es {{NIP}}
Where {{firstName}}, {{company_name}} and {{NIP}} will be replaced by the fields in the form and the generated NIP value. In case of using emil or WhatsApp, you must consider that this will be the message sent to your client with the data of the kiban WhatsApp business account.
Successful response
A successful response will only have an http code 200.
Test the service
You can make sanbox requests to this API, it is not necessary to provide any other parameter to the query, being in a sandbox environment it is assumed that a NIP is sent, but this is not actually sent, sendings are only made in the production environment.
Possible Errors
id workfloo not found
You will get a 404 Not Found error when the workflooId field is not correct in the path parameter request.
NIP previously sent
You will get a 400 Bad Request error when the NIP was previously sent.
Not authorized
If you receive an error code 401, it is because you do not have execution permissions, this happens because the service was consumed with an incorrect API KEY.