Retrieve an Agent Verification

GET 
/v1/agent-verifications/:id

Retrieve an Agent Verification

Request

Path Parameters

id stringrequired

Id of the Agent Verification.

Responses

200

Successfully retrieved a Agent Verification

application/json

Schema

Schema

data

object

idstring

Example: agentverification_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

firstNamestring

Example: Max

lastNamestring

Example: Plank

organisationIdstringnullable

Organisation Id

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisation

object

idstringnullable

Organisation Id

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

emailstringnullable

Organisation email

Example: org@example.com

namenullable

Organisation name

Example: Great Charity

emailemail

Example: example@example.com

languagestring

Example: en-GB

validationRequestIdstringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

validationRequest

object

namestringnullable

Example: Great Charity

titlestringnullable

Example: Board Member

rejectionReasonstringnullabledeprecated

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]

rejectionReasonCodestringnullable

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]

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

statusstring

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

Example: pending

externalActionRequiredboolean

Example: true
objectstring
Example: agent_verification

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"
}

400

Error validating inputs

application/json

Schema

Schema

error

object

codestring

Example: bad_request

titlestring

Example: Bad request

messagestring

Example: One or more of the inputs were invalid

reasonsstring[]

Example (from schema)

{
  "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"
    ]
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

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

404

The specified resource was not found

application/json

Schema

Schema

error

object

codestring

Example: not_found

titlestring

Example: Resource not found

messagestring

Example: This endpoint is unavailable or can not be found

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}