Edit an Agent Verification

PATCH 
/v1/agent-verifications/:id

Update an Agent Verifications metadata.

Request

Path Parameters

id stringrequired

Id of the Agent Verification.

application/json

Body

required

metadata object

Metadata object that will be merged with current metadata object.

property name* string

Max key size is 40 characters. If key matches already existing key, it will override old value

Responses

200

Successfully update Agent Verification metadata

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

InvalidMetadata

400 Bad request

{
  "error": {
    "title": "Bad request",
    "message": "Metadata can only contain from 1 up to 20 keys, with key names up to 50 characters long and values up to 500 characters long",
    "code": "agent_verification/invalid_metadata"
  }
}

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...