API Reference
Add identity verification
/v2/identity_verification https://api.cable.tech Add IDV (Identity Verification) information for a person or company.
Note: Each API call represents a single verification event from one provider at a specific point in time. If you have multiple verification sources or multiple verification attempts, you must make separate API calls for each one.
For example:
- Document verification from Provider A requires one API call
- Database verification from Provider B requires another API call
- Re-verification after data update requires a new API call
Authentication
- Bearer token in the Authorization header
identity_verification:write
Request body
-
verification_idstring requiredUnique identifier for an identity verification. This is the primary identifier for an identity verification and should be unique across all identity verifications. Updates to an identity verification should be made using this identifier.
This can reference:
- Your internal verification record ID
- The original provider’s verification ID (optionally with a prefix)
- Any unique identifier that allows traceability to the original data source
-
timestampstring requiredWhen the identity verification completed, in ISO 8601 format. Use the timestamp from your verification provider’s response.
Format
date-time -
related_company_idstringUnique identifier of the related company entity (used for business contexts). Only one of related_company_id and related_person_id can be specified.
Example
company-id-12345 -
related_person_idstringUnique identifier of the related person entity (used for retail contexts or when a person is the subject). Only one of related_company_id and related_person_id can be specified.
Example
person-id-56789 -
verification_providerstring requiredWhich verification provider verified those attributes for the person or company. If this is an internal process, mention the name of your company.
-
verification_overall_outcomestringResult of IDV screening returned from provider
Example
pass -
verification_typestringAllowed values
DOCUMENT_MATCHDATABASE_MATCHMANUAL_VERIFICATION -
verified_datalist of objects requiredArray of individual data points verified in this verification event only. Each item represents a specific piece of information (name, DOB, address, etc.) that was checked during this particular verification.
Do not include:
- Data points from other verification events
- Aggregated results from multiple verifications
- Data that wasn’t actually verified in this specific check
Example: If this verification only checked name and DOB, only include those two items in the array, even if other data points were verified in previous or separate verification events.
Limits
min items 1-
typestring requiredThe type of data being verified for the person or company
-
outcomestring requiredThe result of the verification for this data being verified
-
valuestringThe actual data that was verified, such as a name or ID number.
-
is_matched_externallybooleanSpecifies whether the data was verified by comparing it with an external source, such as a third-party verification provider, external database, or through documentary verification (e.g., matching documents against regulatory standards).
-
is_manually_verifiedbooleanIndicates whether the data was manually verified by an internal team or trusted individual. This is true when the verification process involves human intervention rather than an automated system, for example when verifying a document.
Responses
201 Identity verification added successfully
-
successboolean requiredIndicates if the write operation was successful.
-
write_countinteger requiredThe number of records written to the database.
Format
int32 -
messagestring requiredProvides additional information about the operation result.
-
organization_idstring requiredThe organization ID for which the operation was performed.
Errors
- 400 Invalid Identity verification data
- 401 Unauthorized request
- 409 Identity verification already exists
- 429 Rate limit exceeded
- 500 Server error
- default General error
-
codeinteger requiredFormat
int32 -
messagestring required -
errorslist of objectsDetailed information about errors in specific fields.
-
fieldstring -
messagestring
-