Create an Agent Verification

POST 
/v1/agent-verifications

Create an Agent Verification

Request

Header Parameters

Idempotency-Key string

Idempotency key

application/json

Body

required

oneOf

MOD1

firstName stringrequired

First name of Agent

Possible values: <= 255 characters

Example: Max

lastName stringrequired

Last name of Agent

Possible values: <= 255 characters

Example: Plank

organisationId stringrequired

Id of the Organisation for which the Agent Verification is for

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

email stringrequired

Email Id of the agent

Possible values: <= 255 characters

Example: example@example.com

title string

Job Title

Possible values: <= 255 characters

Example: Board Member

organisationWebsite websitenullable

Organisation Website link

Possible values: <= 255 characters

language string

Valid RFC 5646 language code

MOD2

firstName stringrequired

First name of Agent

Possible values: <= 255 characters

Example: Max

lastName stringrequired

Last name of Agent

Possible values: <= 255 characters

Example: Plank

validationRequestId stringrequired

Validation Request Id if not part of organisation

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

email stringrequired

Email Id of the agent

Possible values: <= 255 characters

Example: example@example.com

title string

Job Title

Possible values: <= 255 characters

Example: Board Member

organisationWebsite websitenullable

Organisation Website link

Possible values: <= 255 characters

language string

Valid RFC 5646 language code

Example: en-GB

Responses

200

Successfully created a Agent Verification

application/json

Schema

Schema

data

object

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

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

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

OriginalCallInProgress

Idempotency - Original call in progress

{
  "error": {
    "code": "idempotency/original_call_in_progress",
    "title": "Bad request",
    "message": "Original call with this idempotency key is still in progress"
  }
}

SameKeyDifferentData

Idempotency - Data has changed from previous request

{
  "error": {
    "code": "idempotency/same_key_different_data",
    "title": "Bad request",
    "message": "Data has changed from previous request"
  }
}

KeyInUse

Idempotency - Key in use

{
  "error": {
    "code": "idempotency/key_already_in_use",
    "title": "Bad request",
    "message": "Idempotency Key is already in use"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

code string

Example: forbidden

title string

Example: Forbidden

message string

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

Loading...