Create a new identity verification.
Profile vs inline PII: Submit either a profile_id or inline PII/address fields—not both. Combining profile_id with name fields, address, addresses, or other PII returns 400 Bad Request (validation_error: "request must only contain a profile_id, or other fields"). reference_id may be sent alongside profile_id. Empty address: {} or addresses: [] count as supplied address parameters and cannot be paired with profile_id.
For personal_identity_records results, controls whether SSN values in results.people[].ssn are returned in full or masked as XXX-XX-{last4}.
Used by identity verification endpoints only. Driver check endpoints use unmask_ssn instead — see that parameter for precedence rules that apply to results.requested_profile.ssn.
When the product configuration has an explicit unmask_ssn setting (available for personal_identity_records only), that setting takes precedence over this query parameter.
When no product configuration setting exists, false or omitted returns masked SSN values and true returns full SSN values.
If an SSN value is null or empty, it remains null regardless of this parameter.
The request body for creating a new identity verification.
Use either inline PII/address fields or profile_id—not both. See the POST /identity_verifications operation for details.
the request to create a new identity verification from set of PII
The object must have DOB.
Provide first_name and last_name (without full_name).
- identity-verification-request-from-pii
- identity-verification-request-from-profile
- identity-verification-request-from-phone
curl -i -X POST \
'https://api.checkrtrust.com/v1/identity_verifications?include%5B%5D=profile&unmask_ssn=false' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"first_name": "JOHN",
"last_name": "SMITH",
"idv_type": "pii_validation",
"email": "j.doe@example.com"
}'Created. When the product has usage limits configured, the response includes X-RateLimit-Limit, X-RateLimit-Remaining, and optionally X-RateLimit-Expires.
the UUID of the identity verification.
An ISO 8601 formatted date-time string.
The structure of results depends on the value of idv_type.
the UUID of the profile.
The type of identity verification to be done.
| Enum Value | Description |
|---|---|
| pii_validation | When requesting pii_validation, the result will be returned immediately. |
| document_verification | When requesting document_verification, the result will be returned asynchronously through a pre-defined webhook. |
| personal_identity_records | When requesting personal_identity_records, enriched identity information will be returned immediately. |
| reverse_phone | When requesting reverse_phone, identity information associated with the provided phone number will be returned immediately. |
{ "id": "2b8313e8-4efd-45a1-b578-952b8313e890", "created_at": "2020-01-01T00:00:00Z", "results": { "attribute_match_scores": { … }, "overall_match_score": 50, "result_context": [ … ] }, "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890", "profile": { "id": "2b8313e8-4efd-45a1-b578-952b8313e890", "full_name": "string", "first_name": "string", "middle_name": "string", "no_middle_name": false, "last_name": "string", "dob": "19950401", "phone": "+14155552671", "country_code": "string", "email": "john.doe@example.com", "ssn": "123-45-6789", "address": { … }, "addresses": [ … ], "custom_id": "my-custom-id-123", "driver_license_state": "CA", "driver_license_number": "D1234567" }, "idv_type": "pii_validation", "reference_id": "ref-123" }