NIP y oferta

En los ejemplos, {{auto_equity_base_url}} representa la URL base de Auto Equity del entorno seleccionado.

Enviar el NIP al solicitante

Este endpoint envía un NIP de seis dígitos al solicitante por SMS o correo electrónico.

Para cambiar el teléfono o correo electrónico del solicitante, utiliza el endpoint de actualización de contacto.

Los entornos distintos de producción no envían mensajes SMS. Utiliza el NIP predeterminado 123456 para las pruebas.

Información de la solicitud

Método HTTP	URL	Ejemplo
POST	{{auto_equity_base_url}}/api/leads/{{leadId}}/pin	https://stg-api.creditas.io/mx/b2b/autoequity/api/leads/2341b2c8-8e84-4a5a-aac6-9dda4410e999/pin

Cuerpo de la solicitud

Campo	Tipo	Descripción
channel	String enum [“SMS”, “EMAIL”]	Canal utilizado para entregar el NIP. Ej.: “SMS”

Estado de respuesta

El servicio responde con 204 No Content y un cuerpo vacío.

Ejemplo con cURL

curl --location --request POST '{{auto_equity_base_url}}/api/leads/05d3ccd2-26e8-4a85-bde8-509d6888c12b/pin' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel": "EMAIL"
}'

Posibles errores

Consulta los posibles errores.

Solicitar una oferta

Después de recibir el NIP, el solicitante puede autorizar la consulta de su historial crediticio y solicitar una oferta mediante este endpoint.

Correos de prueba para staging

Utiliza uno de estos correos para evitar la consulta de un historial crediticio real:

Correo electrónico	Resultado de la preevaluación
pq-approved@creditas.com	APPROVED
pq-direct-rejected@creditas.com	REJECTED
pq-manual-review@creditas.com	MANUAL_REVIEW

Un resultado de preevaluación APPROVED no garantiza que el solicitante reciba una oferta.

Información de la solicitud

Método HTTP	URL	Ejemplo
POST	{{auto_equity_base_url}}/api/leads/{{leadId}}/offer	https://stg-api.creditas.io/mx/b2b/autoequity/api/leads/2341b2c8-8e84-4a5a-aac6-9dda4410e999/offer

Cuerpo de la solicitud

Campo	Tipo	Descripción
pin	String	NIP recibido por el solicitante. Ej.: “123456”
pinConfirmation	String	El mismo NIP, capturado nuevamente para confirmarlo. Ej.: “123456”

Ejemplo con cURL

curl --location  --request POST '{{auto_equity_base_url}}/api/leads/7809b67d-4dfb-47ff-a4df-ac033569f6e4/offer' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
    "pin": "123456",
    "pinConfirmation": "123456"
}'

Estado de respuesta

El servicio responde con 200 OK y el siguiente cuerpo.

Cuerpo de la respuesta

Campo	Tipo	Descripción
prequalification	Boolean	Indica si el lead tiene una oferta preaprobada.
result	String Enum [“APPROVED”, “MANUAL_REVIEW”, “REJECTED”]	APPROVED — Se genera una oferta preaprobada. MANUAL_REVIEW — El equipo de operaciones revisa la información y envía una contraoferta cuando está disponible. REJECTED — No hay una oferta disponible.
offer	Object Admite null.	Oferta preaprobada o contraoferta. Este valor es null cuando el lead no se preevalúa automáticamente.
offer.id	UUID (String)	Identificador generado de la oferta.
offer.annualInterestRate	Number	Tasa de interés anual.
offer.monthlyPayment	Number	Monto del pago mensual.
offer.term	Integer	Plazo del crédito en meses.
offer.loanAmount	Number	Monto del crédito.
offer.auto	Object	Información del vehículo seleccionado. El vehículo puede cambiarse después.
offer.loanType	String Enum [“REQUESTED”, “PROPOSED”]	REQUESTED cuando el monto solicitado está disponible; PROPOSED cuando una contraoferta indica el monto máximo disponible.
offer.amountFinanced	Number	Monto total financiado, incluidos el costo del GPS y la comisión por apertura.

Ejemplo de respuesta

{
    "prequalification": true,
    "result": "APPROVED",
    "offer": {
        "id": "973f5181-68f1-447b-bf21-326a51e84ab1",
        "annualInterestRate": 31.08,
        "monthlyPayment": 7652.9,
        "term": 24,
        "loanAmount": 120000,
        "auto": {
            "make": "Acura",
            "model": "ILX",
            "year": 2020,
            "price": null,
            "officialPrice": 282100
        },
        "loanType": "REQUESTED",
        "amountFinanced": 123850.26
    }
}

Posibles errores

Consulta los posibles errores aquí.