Skip to content

API Reference

Update identity verification in batch

PUT /v2/identity_verification https://api.cable.tech

Authentication

  • Bearer token in the Authorization header identity_verification:write

Request body

application/json list of objects

An array of identity verification update payloads. Each payload must include the ‘verification_id’ to identify the identity verification and can include any other fields that need to be updated. The ‘timestamp’ field represents the time of update.

  • verification_id string required

    Unique 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
  • timestamp string required

    When the identity verification completed, in ISO 8601 format. Use the timestamp from your verification provider’s response.

    Format date-time

  • related_company_id string

    Unique 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_id string

    Unique 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_provider string required

    Which verification provider verified those attributes for the person or company. If this is an internal process, mention the name of your company.

  • verification_overall_outcome string

    Result of IDV screening returned from provider

    Example pass

  • verification_type string

    Allowed values DOCUMENT_MATCHDATABASE_MATCHMANUAL_VERIFICATION

  • verified_data list of objects required

    Array 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

    • type string required

      The type of data being verified for the person or company

    • outcome string required

      The result of the verification for this data being verified

    • value string

      The actual data that was verified, such as a name or ID number.

    • is_matched_externally boolean

      Specifies 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_verified boolean

      Indicates 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

200 Identity verifications updated successfully

  • success boolean required

    Indicates if the write operation was successful.

  • write_count integer required

    The number of records written to the database.

    Format int32

  • message string required

    Provides additional information about the operation result.

  • organization_id string required

    The organization ID for which the operation was performed.

Errors

  • 400 Invalid identity verification data
  • 401 Unauthorized request
  • 404 Identity verification not found
  • 429 Rate limit exceeded
  • 500 Server error
  • default General error

Error body 400401404429500default

  • code integer required

    Format int32

  • message string required
  • errors list of objects

    Detailed information about errors in specific fields.

    • field string
    • message string