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

idstring

Example: validationsubmission_xxxxxxxxxxxx

validationInviteIdstringnullable

Example: validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

statusstring

Possible values: [pending, processed, failed, succeeded]

Example: pending

organisationIdstringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationNamestringnullable

validationRequestIdstringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

validationRequestNamestringnullabledeprecated

validationRequest

object

nullable

acceptedAtdate-timenullable

Example: 2022-02-02T17:46:54.000Z

rejectedAtdate-timenullable

Example: 2022-02-02T17:46:54.000Z

idstring

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

organisationTypesstring[]

Possible values: [nonprofit, social_impact]

monitoringSubscriptionIdstringnullable

Example: monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

agentVerificationIdstringnullable

Example: agentverification_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

agentVerification

object

nullable

idstring

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

emailstring

firstNamestring

lastNamestring

statusstring

Possible values: [pending, pending_user_verification, pending_review, approved, rejected]

rejectionReasonstringnullabledeprecated

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]

rejectionReasonCodestringnullable

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]

languagestring

Default value: en-GB

Example: en-GB

eligibilitySubscriptionIdstringnullable

Example: eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

eligibility

object

statusstring

Possible values: [live, pending_validation_request, validation_request_failed, pending, cancelled, cannot_define_eligibility]

Example: live

results

object

eligibilityStatusstringnullable

Possible values: [pass, fail]

Example: fail

confirmedActivitySubTagsstring[]nullable

rejectedActivitySubTagsstring[]nullable

Confirmed organisation's activity subtags that are not allowed in partner's configuration

organisation

object

nullable

namestringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

countryCodestring

3-letter ISO country code

Example: AUS

processedAtdate-timenullable

Example: 2022-02-02T17:46:54.000Z

createdAtdate-time

Example: 2022-02-02T17:46:54.000Z

metadataobjectnullable

Key-value data that you can attach to an object.

Example: {"key1":"value1","key2":"value2"}

partnerFieldsobjectnullable

Responses for custom partner questions

Example: {"key1":"value1","key2":"value2"}

configuration

object

idstring

Validation Submission configuration id

Example: hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestringnullable

Validation Submission configuration name

allowedOrganisations

object

typesstring[]

Possible values: [social_impact, nonprofit, education]

agentVerificationEmailstringnullabledeprecated

agentVerificationFirstNamestringnullabledeprecated

agentVerificationLastNamestringnullabledeprecated

agentVerificationRejectionReasonstringnullabledeprecated

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]

agentVerificationRejectionReasonCodestringnullabledeprecated

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]

agentVerificationStatusstringdeprecated

Possible values: [pending, pending_user_verification, pending_review, approved, rejected]

validationRequestAcceptedAtdate-timenullabledeprecated

Example: 2022-02-02T17:46:54.000Z

validationRequestRejectedAtdate-timenullabledeprecated

Example: 2022-02-02T17:46:54.000Z

Example (from schema)

{
  "data": {}
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

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

404

The specified resource was not found

application/json

Schema

Schema

error

object

codestring

Example: not_found

titlestring

Example: Resource not found

messagestring

Example: This endpoint is unavailable or can not be found

Example (from schema)

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