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

Possible values: <= 255 characters

First name of Agent

lastName stringrequired

Possible values: <= 255 characters

Last name of Agent

organisationId stringrequired

Id of the Organisation for which the Agent Verification is for

email stringrequired

Possible values: <= 255 characters

Email Id of the agent

title string

Possible values: <= 255 characters

Job Title

organisationWebsite websitenullable

Possible values: <= 255 characters

Organisation Website link

language string

Valid RFC 5646 language code

MOD2

firstName stringrequired

Possible values: <= 255 characters

First name of Agent

lastName stringrequired

Possible values: <= 255 characters

Last name of Agent

validationRequestId stringrequired

Validation Request Id if not part of organisation

email stringrequired

Possible values: <= 255 characters

Email Id of the agent

title string

Possible values: <= 255 characters

Job Title

organisationWebsite websitenullable

Possible values: <= 255 characters

Organisation Website link

language string

Valid RFC 5646 language code

Responses

200

Successfully created a Agent Verification

application/json

Schema

Schema

data object
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

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
title string
message string

Example (from schema)

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

Loading...