Get the status of a rating request by its ID.

Retrieve the current status of a specific rating request using its unique ID.

SecurityAPIKeyHeader

Request

path Parameters

rate_request_id

required

string (Rate Request Id)

Responses

200

Successful Response

Response Schema: application/json

id required	string (Id)
status required	string (RateStatus) Enum: "CREATED" "PROCESSING" "ERRORED" "SUCCEEDED" "CANCELLED" "EXPIRED" "REVOKED" "COMPLETED"
required	Array of objects (Provider Tasks)

400

Validation Error

404

The resource requested was not found either because you do not have permissions to access it or it does not exist.

500

An unknown internal server issue occured while processing a request. A report is created and logged.

get/rating/{rate_request_id}/status

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"id": "rj_01hzkd8qkzq8z7xv9mkz5qxw3h",
"provider_tasks": [{"id": "rd_01hzkd8wfaz1zmjw5k0g3q9z1e",
"provider_code": "UPS",
"status": "PROCESSING"
},
{"id": "rd_01hzkd8xbz2z1kgc9m3r7n8x2f",
"provider_code": "FEDEX",
"status": "COMPLETED"
}
],
"status": "PROCESSING"
}