List Validation Submissions

GET 
/v1/validation-submissions

List Validation Submissions

Request

Query Parameters

direction string

Possible values: [ASC, DESC]

Which way to sort by the given 'sort' field. Default DESC

cursor string

A cursor that points to where to start the page

pageSize integer

Default value: 25

How many items per page, for pagination.

status string

Possible values: [incomplete, pending, processed, failed, succeeded]

Filter by Validation Submission status

query string
Search by agent verification email, organisation name or validation request name
Example: example@example.com

Responses

200

Successfully retrieved list of Validation Submissions

application/json

Schema

Schema

data object[]
object string
totalResults integer
pageSize integer
_links object
current string
next string
prev string

Example (from schema)

{
  "data": [
    {
      "id": "validationsubmission_xxxxxxxxxxxx",
      "validationInviteId": "validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "status": "pending",
      "organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "organisationName": "string",
      "validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "validationRequest": {
        "acceptedAt": "2022-02-02T17:46:54.000Z",
        "rejectedAt": "2022-02-02T17:46:54.000Z",
        "id": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "name": "string",
        "organisationTypes": [
          "nonprofit"
        ]
      },
      "monitoringSubscriptionId": "monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "agentVerificationId": "agentverification_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "agentVerification": {
        "id": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "status": "pending",
        "rejectionReasonCode": "validation_request_failed"
      },
      "eligibilitySubscriptionId": "eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "processedAt": "2022-02-02T17:46:54.000Z",
      "createdAt": "2022-02-02T17:46:54.000Z",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "partnerFields": {
        "key1": "value1",
        "key2": "value2"
      },
      "configuration": {
        "id": "hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "name": "string"
      }
    }
  ],
  "object": "validation_submission",
  "totalResults": 33,
  "pageSize": 25,
  "_links": {
    "current": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
    "next": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
    "prev": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D"
  }
}

400

Bad request

application/json

Schema

Schema

error object
code string
title string
message string
reasons string[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

400 Incorrect Parameters

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

CursorError

Error in cursor parameter

{
  "error": {
    "code": "pagination/cursor_error",
    "title": "Bad request",
    "message": "Unable to find the next page"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}

Loading...