GET
/
credit_scores
List credit scores
curl --request GET \
  --url https://api.synctera.com/v1/credit_scores \
  --header 'Authorization: Bearer <token>'
{
  "next_page_token": "a8937a0d",
  "credit_scores": [
    {
      "customer_id": "64438afd-fa20-4010-a573-2bbdca77cdb6",
      "score": 700,
      "score_requested_time": "2020-01-01T00:00:00.000Z",
      "source_of_score": "ACCOUNT_OPENING",
      "type": "FICO",
      "vendor_name": "EQUIFAX",
      "version": "8",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
id
string<uuid>[]

Return the credit score with the specified id. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
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

​
customer_id
string<uuid>[]

Return the credit scores associated with the specified customer. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

Response

201
application/json

list of credit scores

The response is of type object.