Risk Evaluation API
The banca.me risk evaluation API provides endpoints for creating and retrieving pre-loan requests (leads) and their risk evaluation. This API is designed for partners who want to integrate banca.me's risk evaluation and loan processing capabilities into their applications.
Features
- Get or create a lead by RUT and send the customer to continue the application at banca.me
- List every lead of a RUT that belongs to your partner
- Risk evaluation results (pre-approvals, risk parameters and reports) for partners with the
evaluationmodule
Base URL
The base URL for production API requests is:
https://api.banca.me
For integration and testing use https://beta.api.banca.me (development) or
https://automation.api.banca.me (automation). See Environments.
Authentication
Send your API token as Authorization: Bearer <token>. See Authentication.
- A missing or malformed token returns
401. - A well-formed token that is not your partner's current API token returns
400. - A token whose partner is inactive returns
403.
Error Handling
The API uses standard HTTP status codes. Codes you can receive:
- 400: Bad Request
- 401: Unauthorized
- 403: Forbidden
- 404: Not Found
- 409: Conflict
- 413: The customer has a signed loan request pending approval
- 422: Unprocessable Entity
- 500: Internal Server Error
- 503: Service Unavailable — failures of banca.me or of its data providers are usually reported as
503
Error bodies are JSON with this shape:
{
"data": {
"status": 422,
"url": "/partner/pre-loan-request",
"ip": "203.0.113.10",
"partnerId": "5b0e7c41-2d93-4f8a-a1c6-9e47d2b80f35",
"message": "ERR_MISSING_BASIC_V2_DATA"
}
}
Only 422 and 500 responses carry an error code, in message. Every other status carries
no code, so branch on the HTTP status. See Errors.
Data formats
The API accepts and returns data in the following formats:
- Request: application/x-www-form-urlencoded or application/json
- Response: application/json
Best practices
- Error Handling:
- Always implement proper error handling
- Check HTTP status codes
- Implement retry logic for temporary failures (
503)
- Data Validation:
- Validate the RUT check digit and the phone format (
+56 XXXXXXXXX) before sending - Check response data integrity
- Handle missing or null values gracefully
Authentication
- HTTP: Bearer Auth
Partner API token provided by banca.me
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |