Create a Validation Submission

POST 
/v1/validation-submissions

Create a Validation Submission

Request

Header Parameters

Idempotency-Key string

Idempotency key

application/json

Body

required

oneOf

MOD1

configurationIdstring

Id of the Validation Submission Configuration associated with submission

Example: hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationNamestringrequired

Name of organisation

Possible values: <= 255 characters

registryNamestringrequired

Name of organisation's registry

Possible values: <= 255 characters

registryIdstringrequired

Organisations's id in registry

organisationEmailstring

Organisation's email

Possible values: <= 255 characters

Example: test@goodstack.internal

addressLine1string

Organisation's address line 1

Possible values: <= 255 characters

Example: 44 Clipstone St

addressLine2string

Organisation's address line 2

Possible values: <= 255 characters

Example: House 40, Threeways

citystring

Organisation's city

Possible values: <= 255 characters

Example: London

postalstring

Organisation's postal code

Possible values: <= 255 characters

Example: W1W 5DW

statestring

Organisation's state

Possible values: <= 255 characters

Example: Texas

websitewebsiterequired

Organisation's website

Possible values: <= 255 characters

Example: https://example.com

countryCodestringrequired

Three-letter ISO country code

Example: POL

firstNamestring

First name of Agent

Possible values: <= 255 characters

Example: Max

lastNamestring

Last name of Agent

Possible values: <= 255 characters

Example: Plank

emailstring

Email of Agent

Possible values: <= 255 characters

Example: test@goodstack.internal

titlestring

Agent's job title

Possible values: <= 255 characters

Example: Board Member

languagestringrequired

Valid RFC 5646 language code

Example: en-GB

metadata

object

Metadata object.

property name*string

Max key size is 40 characters

MOD2

configurationIdstring

Id of the Validation Submission Configuration

Example: hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationIdstringrequired

OrganisationId of the Agent

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

firstNamestring

First name of Agent

Possible values: <= 255 characters

Example: Max

lastNamestring

Last name of Agent

Possible values: <= 255 characters

Example: Plank

emailstring

Email of Agent

Possible values: <= 255 characters

Example: test@goodstack.internal

titlestring

Agent's job title

Possible values: <= 255 characters

Example: Board Member

websitewebsite

Organization's website

Possible values: <= 255 characters

Example: https://goodstack.internal

languagestringrequired

Valid RFC 5646 language code

Example: en-GB

metadata

object

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 created a Validation Submission

application/json

Schema

Schema

data

object

idstring

Example: validationsubmission_xxxxxxxxxxxx

validationInviteIdstringnullable

Example: validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

statusstring

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

Example: pending

processedAtdate-timenullable

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

organisationIdstringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationNamestringnullable

monitoringSubscriptionIdstringnullable

Example: monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

eligibilitySubscriptionIdstringnullable

Example: eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

createdAtdate-time

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

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, invalid_documentation, nonprofit_association_expired, fake_documentation, mismatched_information, blank_corrupted_documentation, suspicious_application, other]

validationRequestIdstringnullable

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

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

namestringnullable

organisationTypesstring[]

Possible values: [nonprofit, social_impact]

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

monitoring

object

statusstring

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

Example: live

results

object

complianceStatusstringnullable

Possible values: [pass, fail]

Example: fail

registration

object

activestring

Possible values: [yes, no]

Example: no

warning

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

sanction

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

controversial

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

commercial

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

adverseMedia

object

nullable

statusstring

Possible values: [clear, flag]

Example: clear

hateSpeech

object

nullable

statusstring

Possible values: [clear, flag]

Example: flag

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]

objectstring
Example: validation_submission

Example (from schema)

{
  "data": {
    "id": "validationsubmission_xxxxxxxxxxxx",
    "validationInviteId": "validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": "pending",
    "processedAt": "2022-02-02T17:46:54.000Z",
    "organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "organisationName": "string",
    "monitoringSubscriptionId": "monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "eligibilitySubscriptionId": "eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "createdAt": "2022-02-02T17:46:54.000Z",
    "agentVerificationId": "agentverification_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "agentVerification": {
      "id": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "status": "pending",
      "rejectionReasonCode": "validation_request_failed"
    },
    "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"
      ]
    },
    "eligibility": {
      "status": "live",
      "results": {
        "eligibilityStatus": "fail",
        "confirmedActivitySubTags": [
          "activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        ],
        "rejectedActivitySubTags": [
          "activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        ]
      }
    },
    "monitoring": {
      "status": "live",
      "results": {
        "complianceStatus": "fail",
        "registration": {
          "active": "no"
        },
        "warning": {
          "status": "flag"
        },
        "sanction": {
          "status": "flag"
        },
        "controversial": {
          "status": "flag"
        },
        "commercial": {
          "status": "flag"
        },
        "adverseMedia": {
          "status": "clear"
        },
        "hateSpeech": {
          "status": "flag"
        }
      }
    },
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "partnerFields": {
      "key1": "value1",
      "key2": "value2"
    },
    "configuration": {
      "id": "hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "name": "string",
      "allowedOrganisations": {
        "types": [
          "social_impact"
        ]
      }
    }
  },
  "object": "validation_submission"
}

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

OrganisationNotFound

400 Bad request

{
  "error": {
    "code": "validation_submission/organisation_not_found",
    "title": "Bad request",
    "message": "Organisation was not found"
  }
}

OrganisationNotActive

400 Bad request

{
  "error": {
    "code": "validation_submission/organisation_not_active",
    "title": "Bad request",
    "message": "Organisation is not active"
  }
}

ValidationSubmissionDocumentNotFound

400 Bad request

{
  "error": {
    "code": "validation_submission/validation_submission_document_not_found",
    "title": "Bad request",
    "message": "Validation submission document was not found"
  }
}

ValidationRequestNotFound

400 Bad request

{
  "error": {
    "code": "validation_submission/validation_request_not_found",
    "title": "Bad request",
    "message": "Validation request was not found"
  }
}

ValidationRequestAlreadyRejected

400 Bad request

{
  "error": {
    "code": "validation_submission/validation_request_already_rejected",
    "title": "Bad request",
    "message": "Validation request already rejected"
  }
}

EntityNotFound

400 Bad request

{
  "error": {
    "code": "validation_submission/entity_not_found",
    "title": "Bad request",
    "message": "Organisation or validation request was not found"
  }
}

InvalidSubTags

400 Bad request

{
  "error": {
    "code": "validation_submission/invalid_sub_tags",
    "title": "Bad request",
    "message": "At least one of provided subtags is invalid"
  }
}

InvalidConfiguration

404 Not Found

{
  "error": {
    "code": "validation_submission/invalid_configuration_id",
    "title": "Not Found",
    "message": "Provided configurationId is not valid"
  }
}

OriginalCallInProgress

Idempotency - Original call in progress

{
  "error": {
    "code": "idempotency/original_call_in_progress",
    "title": "Bad request",
    "message": "Original call with this idempotency key is still in progress"
  }
}

SameKeyDifferentData

Idempotency - Data has changed from previous request

{
  "error": {
    "code": "idempotency/same_key_different_data",
    "title": "Bad request",
    "message": "Data has changed from previous request"
  }
}

KeyInUse

Idempotency - Key in use

{
  "error": {
    "code": "idempotency/key_already_in_use",
    "title": "Bad request",
    "message": "Idempotency Key is already in use"
  }
}

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