Skip to main content
POST
/
v1
/
crm
/
leads
/
{leadId}
/
validations
/
equifax
/
credit
Equifax Credit Report
curl --request POST \
  --url https://api.example.com/v1/crm/leads/{leadId}/validations/equifax/credit \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": "<unknown>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "additionalInfo": null,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Enter token in following format: Bearer

Path Parameters

​
leadId
string
required

Response

The Equifax credit validation result.

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
entityId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
entityType
enum<string>
required
Available options:
lead,
client,
user,
processor,
document,
ticket,
transactions,
batch,
statement
​
vendor
enum<string>
required
Available options:
giact,
tincheck,
equifax,
match,
datax
​
service
enum<string>
required
Available options:
credit,
state_id,
bank,
termination_inquiry,
retroactive_inquiry,
retroactive_inquiry_details,
tin_address,
id_verification
​
result
any
required
​
createdAt
string
required
​
updatedAt
string
required
​
status
enum<string> | null
Available options:
pending,
pass,
fail,
error
​
documentId
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
additionalInfo
unknown
​
createdBy
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
updatedBy
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$