Skip to main content
GET
List CRRs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id
string<uuid>

ID of the customer that the risk score applies to

Example:

"77275c65-8702-4b27-8e60-20f4292054ac"

include_history
boolean
default:false

If true, include old risk scores in the response

page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

business_id
string<uuid>

ID of the business that the risk score applies to

Example:

"edebece0-4a06-4806-b062-7de25a848be8"

Response

List of CRR for customers, or businesses

risk_scores
object[]
required

Array of risk scores

next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"