Get identity proofing result data in bulk

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

Query Parameters

• query object

  Allows for pagination and sorting using the deepObject notation.

  
  

  resource?query[limit]=50&query[offset]=0&query[order]=label

  
  

  Parameter	Description	Default
  limit	Limits the number of results returned	100
  offset	Returns the results starting at the value provided	0
  order	Allows you to determine the order in which the data is returned (not available on profile attributes)	id

  Example: query[limit]=100&query[offset]=50&query[order]=created_at
• profile_id uuid

  Profile ID to filter by

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
• workflow_session_id uuid

  Workflow Session ID to filter by

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
• result string

  Possible values: [pass, fail]

  ID Proofing Result to filter by

  Example: fail
• metadata boolean

  Returns batching metadata in the response

  Example: true

Responses

• 200

---

Expected response to a valid request

application/json

• Schema
• Example (from schema)

---

Schema

• identity_proofing_results object[]

  id uuid

  the id

  identity_proofing_action_id uuid

  The identity_proofing_action_id

  workflow_session_id uuid

  the workflow_session_id

  profile_id uuid

  the profile_id

  proofing_workflow uuid

  the proofing workflow id

  result string

  Possible values: [pending, pass, fail]

  the result of the identity proofing

  proofing_attributes object

  Any additional attributes associated with the proofing

  property name* string

  created_at date-time

  The created at time

  updated_at date-time

  The updated at time

• _metadata object

  limit int32

  The limit

  offset int32

  The offset

  total int32

  The total

  next string

  The link to the next page of data

  previous string

  The link to the previous page of data

{
  "identity_proofing_results": [
    {
      "id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "identity_proofing_action_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "workflow_session_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "profile_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "proofing_workflow": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "result": "pass",
      "proofing_attributes": {
        "result": "approve"
      },
      "created_at": "2023-05-01T09:12:28Z",
      "updated_at": "2023-05-01T09:12:28Z"
    }
  ],
  "_metadata": {
    "limit": 50,
    "offset": 100,
    "total": 10000,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

Loading...