Get identity proofing result data in bulk

GET 
/identity_proofing_results

This endpoint can retrieve identity proofing result data in bulk from Lifecycle

Request

Query Parameters

query object

Allows for pagination and sorting.

profile_id uuid

Profile ID to filter by

workflow_session_id uuid

Workflow Session ID to filter by

result string

Possible values: [pass, fail]

ID Proofing Result to filter by

metadata boolean

Returns batching metadata in the response

Responses

200

Expected response to a valid request

application/json

Schema

Schema

identity_proofing_results object[]
Array [
id uuid
identity_proofing_action_id uuid
workflow_session_id uuid
profile_id uuid
proofing_workflow uuid
result string
Possible values: [pending, pass, fail]
proofing_attributes object
property name* string
created_at date-time
updated_at date-time
]
_metadata object
limit integer
offset integer
total integer
next string
previous string

Example (from schema)

{
  "identity_proofing_results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "identity_proofing_action_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "workflow_session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proofing_workflow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "result": "pending",
      "proofing_attributes": {
        "result": "approve"
      },
      "created_at": "2024-04-27T13:12:55.961Z",
      "updated_at": "2024-04-27T13:12:55.961Z"
    }
  ],
  "_metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

Loading...