Credit Risk β Status
Poll assessment progress with the unique_id from POST /api/v1/credit-risk/assess. Not billed. When completed=true, call GET /api/v1/credit-risk/results/{unique_id}.
Request
GET/api/v1/credit-risk/status/{unique_id}
{{baseUrl}}/api/v1/credit-risk/status/{unique_id}Header
In progress
Expected response for In progress:
200 OKSample dataExpected response
{
"success": true,
"response_code": 200,
"message": "Analysis in progress",
"data": {
"unique_id": "cra-doc-abc123",
"document_type": "BANK",
"state_name": "UPLOADED",
"completed": false,
"failed": false
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}Complete
Expected response for Complete:
200 OKSample dataExpected response
{
"success": true,
"response_code": 200,
"message": "Analysis complete",
"data": {
"unique_id": "cra-doc-abc123",
"document_type": "BANK",
"state_name": "COMPLETED",
"completed": true,
"failed": false
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}Failed
Expected response for Failed:
200 OKSample dataExpected response
{
"success": true,
"response_code": 200,
"message": "Assessment failed",
"data": {
"unique_id": "cra-doc-abc123",
"document_type": "BANK",
"state_name": "REJECTED",
"completed": false,
"failed": true
},
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}Response Fields
Error codes
Standard Peleza HTTP / response_code values (same across all API calls). Validation message text is endpoint-specific. Full reference: Error Codes.
Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.
