List Agent Verifications

GET 
/v1/agent-verifications

List Agent Verifications

Request

Query Parameters

status string

Possible values: [pending, pending_user_verification, pending_review, approved, rejected]

email string
filter on the Agent Verification list by email
Example: joe
startDate date-time
Start date to filter Agent Verifications.
Example: 2020-10-13T17:46:54.000Z
endDate date-time
End date to filter Agent Verifications.
Example: 2020-10-13T17:46:54.000Z
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.

Responses

200

Successfully retrieved list of Agent Verifications

application/json

Schema

Schema

data object[]
Array [
id string
firstName string
lastName string
organisationId stringnullable
Organisation Id
organisation object
id stringnullable
Organisation Id
email stringnullable
Organisation email
name nullable
Organisation name
email email
language string
validationRequestId stringnullable
validationRequest object
name stringnullable
title stringnullable
rejectionReason stringnullabledeprecated
Possible values: [Validation request failed, User verification expired, Identity check failed, No evidence agent’s email is associated with organisation, Agent/nonprofit will reapply, Agent used fake or test email, No online presence to complete check, Nonprofit association expired, Other]
Reason for rejecting agent verification
rejectionReasonCode stringnullable
Possible values: [validation_request_failed, user_verification_expired, user_failed_percent_review, reapply, fake_email_used, no_online_presence, nonprofit_association_expired, invalid_documentation, fake_documentation, mismatched_information, blank_corrupted_documentation, suspicious_application, other]
Reason code for rejecting agent verification
createdAt date-time
status string
Possible values: [pending, pending_user_verification, pending_review, approved, rejected]
externalActionRequired boolean
]
object string
totalResults integer
pageSize integer
_links object
current string
next string
prev string

Example (from schema)

{
  "data": [
    {
      "id": "agentverification_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "firstName": "Max",
      "lastName": "Plank",
      "organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "organisation": {
        "id": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "email": "org@example.com",
        "name": "Great Charity"
      },
      "email": "example@example.com",
      "language": "en-GB",
      "validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "validationRequest": {
        "name": "Great Charity"
      },
      "title": "Board Member",
      "rejectionReasonCode": "validation_request_failed",
      "createdAt": "2020-10-13T17:46:54.000Z",
      "status": "pending",
      "externalActionRequired": true
    }
  ],
  "object": "agent_verification",
  "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...