Skip to main content

Edit an Agent Verification

PATCH 
/v1/agent-verifications/:id

Update an Agent Verifications metadata.

Request​

Path Parameters

    id stringrequired

    Id of the Agent Verification.

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​

Successfully update Agent Verification metadata

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