logo

Retrieve a customer's EDD score

Retrieves an EDD score for a customer with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

EDD score retrieved.

Response Schema: application/json
object
occupation
string (EddScore)
Enum: "not-found" "unlikely" "unclear" "probable" "confirmed"
arrest
string (EddScore)
Enum: "not-found" "unlikely" "unclear" "probable" "confirmed"
bankruptcy
string (EddScore)
Enum: "not-found" "unlikely" "unclear" "probable" "confirmed"
fraud
string (EddScore)
Enum: "not-found" "unlikely" "unclear" "probable" "confirmed"
object (EddScoreDetails)
url
string <uri>

URL from which the score is obtained.

details
string

Text from which the score is obtained.

object (EddScoreDetails)
url
string <uri>

URL from which the score is obtained.

details
string

Text from which the score is obtained.

object (EddScoreDetails)
url
string <uri>

URL from which the score is obtained.

details
string

Text from which the score is obtained.

object (EddScoreDetails)
url
string <uri>

URL from which the score is obtained.

details
string

Text from which the score is obtained.

object (EddData)
occupation
string (EddScore)
Enum: "not-found" "unlikely" "unclear" "probable" "confirmed"
arrest
string (EddScore)
Enum: "not-found" "unlikely" "unclear" "probable" "confirmed"
bankruptcy
string (EddScore)
Enum: "not-found" "unlikely" "unclear" "probable" "confirmed"
fraud
string (EddScore)
Enum: "not-found" "unlikely" "unclear" "probable" "confirmed"
nextUpdateTime
string or null <date-time>

Date and time in ISO 8601 format when the EDD score is updated.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/customers/{id}/edd-score
Request samples 
Response samples 
application/json
{
  • "parsedScore": {
    },
  • "score": {
    },
  • "nextUpdateTime": "2019-08-24T14:15:22Z",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Update a customer's EDD score