EndClient API

Update end clients status in bulk

Changed on
put/end-clients/status

Request

  • Base URL
    https://api.trulioo.com/wfs/interpreter-v2
  • URL
    https://api.trulioo.com/wfs/interpreter-v2/end-clients/status
  • Auth
    none required

Request body

endClientIdsstring[]

A list of unique identifiers for the clients to update. A maximum of 2000 IDs can be included.

status'ACCEPTED' | 'REJECTED' | 'PENDING_REVIEW' | 'IN_PROGRESS' | 'NOT_STARTED' | 'ABANDONED'

The new status to apply to all specified clients. The request will be validated to ensure only permitted status transitions occur.

Allowed Transitions:

  • From Accepted to Declined or Pending Review
  • From In Progress to Abandoned
  • From Not Started to Abandoned
  • From Declinedto Accepted or Pending Review
  • From Pending Review to Accepted or Declined

Note: Leads with a status of Abandoned cannot be updated.

noteBodystring

A note detailing the reason for the status update.

Response

The status for the end clients was updated

Changes

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status