Skip to main content

Create a Validation Submission

POST 

/v1/validation-submissions

Create a Validation Submission

Request​

Header Parameters

    Idempotency-Key string

    Idempotency key

Body

required

    oneOf

    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

Responses​

Successfully created a Validation Submission

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