POST
/
credit_scores
Create a credit score and associate it with a customer
curl --request POST \
  --url https://api.synctera.com/v1/credit_scores \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
}'
{
  "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.

Headers

​
Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

credit score to be created

​
customer_id
string<uuid>
required

The unique identifier of a customer

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6"

​
source_of_score
enum<string>
required

The source of the credit score

Available options:
ACCOUNT_MANAGEMENT,
ACCOUNT_OPENING,
HARDSHIP,
LINE_INCREASE_REQUEST,
OTHER
Example:

"ACCOUNT_OPENING"

​
score
integer

The credit score value

Example:

700

​
score_requested_time
string<date-time>

The time the credit score was requested

Example:

"2020-01-01T00:00:00.000Z"

​
type
string

The type of the credit score

Example:

"FICO"

​
vendor_name
enum<string>

The name of the credit score provider

Available options:
EQUIFAX,
EXPERIAN,
OTHER,
TRANSUNION
Example:

"EQUIFAX"

​
version
string

The version of the credit score

Example:

"8"

Response

Created credit score.

​
customer_id
string<uuid>
required

The unique identifier of a customer

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6"

​
source_of_score
enum<string>
required

The source of the credit score

Available options:
ACCOUNT_MANAGEMENT,
ACCOUNT_OPENING,
HARDSHIP,
LINE_INCREASE_REQUEST,
OTHER
Example:

"ACCOUNT_OPENING"

​
creation_time
string<date-time>
required

The date and time the note was created.

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required

credit score ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
last_updated_time
string<date-time>
required

The date and time the note was last updated.

Example:

"2010-05-06T12:23:34.321Z"

​
score
integer

The credit score value

Example:

700

​
score_requested_time
string<date-time>

The time the credit score was requested

Example:

"2020-01-01T00:00:00.000Z"

​
type
string

The type of the credit score

Example:

"FICO"

​
vendor_name
enum<string>

The name of the credit score provider

Available options:
EQUIFAX,
EXPERIAN,
OTHER,
TRANSUNION
Example:

"EQUIFAX"

​
version
string

The version of the credit score

Example:

"8"