Retrieve a Validation Submission

GET 
/v1/validation-submissions/:id

Retrieve a Validation Submission

Request

Path Parameters

id stringrequired

Id of the Validation Submission.

Responses

200

Successfully retrieves a Validation Submission

application/json

Schema

Schema

data object
id string
validationInviteId stringnullable
status string
Possible values: [pending, processed, failed, succeeded]
organisationId stringnullable
organisationName stringnullable
validationRequestId stringnullable
validationRequestName stringnullabledeprecated
validationRequest objectnullable
acceptedAt date-timenullable
rejectedAt date-timenullable
id string
name string
organisationTypes string[]
Possible values: [nonprofit, social_impact]
monitoringSubscriptionId stringnullable
agentVerificationId stringnullable
agentVerification objectnullable
id string
email string
firstName string
lastName string
status string
Possible values: [pending, pending_user_verification, pending_review, approved, rejected]
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
eligibilitySubscriptionId stringnullable
processedAt date-timenullable
createdAt date-time
metadata objectnullable
Key-value data that you can attach to an object.
partnerFields objectnullable
Responses for custom partner questions
configuration object
id string
Validation Submission configuration id
name stringnullable
Validation Submission configuration name
agentVerificationEmail stringnullabledeprecated
agentVerificationFirstName stringnullabledeprecated
agentVerificationLastName stringnullabledeprecated
agentVerificationRejectionReason 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, Other]
agentVerificationRejectionReasonCode stringnullabledeprecated
Possible values: [validation_request_failed, user_verification_expired, user_failed_percent_review, invalid_documentation, reapply, fake_email_used, no_online_presence, fake_documentation, mismatched_information, blank_corrupted_documentation, suspicious_application, other]
agentVerificationStatus stringdeprecated
Possible values: [pending, pending_user_verification, pending_review, approved, rejected]
validationRequestAcceptedAt date-timenullabledeprecated
validationRequestRejectedAt date-timenullabledeprecated

Example (from schema)

{
  "data": {
    "id": "validationsubmission_xxxxxxxxxxxx",
    "validationInviteId": "validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": "pending",
    "organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "organisationName": "string",
    "validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "validationRequest": {
      "acceptedAt": "2022-02-02T17:46:54.000Z",
      "rejectedAt": "2022-02-02T17:46:54.000Z",
      "id": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "name": "string",
      "organisationTypes": [
        "nonprofit"
      ]
    },
    "monitoringSubscriptionId": "monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "agentVerificationId": "agentverification_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "agentVerification": {
      "id": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "status": "pending",
      "rejectionReasonCode": "validation_request_failed"
    },
    "eligibilitySubscriptionId": "eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "processedAt": "2022-02-02T17:46:54.000Z",
    "createdAt": "2022-02-02T17:46:54.000Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "partnerFields": {
      "key1": "value1",
      "key2": "value2"
    },
    "configuration": {
      "id": "hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "name": "string"
    }
  }
}

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

404

The specified resource was not found

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

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

Loading...