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

Example: validationsubmission_xxxxxxxxxxxx

validationInviteId stringnullable

Example: validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

status string

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

Example: pending

organisationId stringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationName stringnullable

validationRequestId stringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

validationRequestName stringnullabledeprecated

validationRequest

object

nullable

acceptedAt date-timenullable

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

rejectedAt date-timenullable

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

id string

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name string

organisationTypes string[]

Possible values: [nonprofit, social_impact]

monitoringSubscriptionId stringnullable

Example: monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

agentVerificationId stringnullable

Example: agentverification_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

agentVerification

object

nullable

id string

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

email string

firstName string

lastName string

status string

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

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]

language string

Default value: en-GB

Example: en-GB

eligibilitySubscriptionId stringnullable

Example: eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

eligibility

object

status string

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

Example: live

results

object

eligibilityStatus stringnullable

Possible values: [pass, fail]

Example: fail

confirmedActivitySubTags string[]nullable

rejectedActivitySubTags string[]nullable

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

organisation

object

nullable

name stringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

countryCode string

3-letter ISO country code

Example: AUS

processedAt date-timenullable

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

createdAt date-time

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

metadata objectnullable

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

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

partnerFields objectnullable

Responses for custom partner questions

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

configuration

object

id string

Validation Submission configuration id

Example: hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name stringnullable

Validation Submission configuration name

allowedOrganisations

object

types string[]

Possible values: [social_impact, nonprofit, education]

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

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

validationRequestRejectedAt date-timenullabledeprecated

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

Example (from schema)

{
  "data": {}
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

code string

Example: forbidden

title string

Example: Forbidden

message string

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

code string

Example: not_found

title string

Example: Resource not found

message string

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

Loading...