Skip to main content

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

    How many items per page, for pagination.

    Default value: 25

Responses​

Successfully retrieved list of Agent Verifications

Schema

    data

    object[]

  • Array [

    • id string
    Example: agentverification_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    firstName string
    Example: Max
    lastName string
    Example: Plank
    organisationId stringnullable

    Organisation Id

    Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

    organisation

    object

    id stringnullable

    Organisation Id

    Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    email stringnullable

    Organisation email

    Example: org@example.com
    name nullable

    Organisation name

    Example: Great Charity
    email email
    Example: example@example.com
    language string
    Example: en-GB
    validationRequestId stringnullable
    Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

    validationRequest

    object

    name stringnullable
    Example: Great Charity
    title stringnullable
    Example: Board Member
    rejectionReason stringnullabledeprecated

    Reason for rejecting agent verification

    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]

    rejectionReasonCode stringnullable

    Reason code for rejecting agent verification

    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]

    createdAt date-time
    Example: 2020-10-13T17:46:54.000Z
    status string

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

    Example: pending
    externalActionRequired boolean
    Example: true

  • ]

    • object string
    Example: agent_verification
    totalResults integer
    Example: 33
    pageSize integer
    Example: 25

    _links

    object

    current string
    Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D
    next string
    Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D
    prev string
    Example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D
Loading...