Skip to main content

Create a Validation Request

POST 
/v1/validation-requests

Create a Validation Request

Request​

Header Parameters

    Idempotency-Key string

    Idempotency key

Body

required

    name stringrequired

    Name of the charity to validate

    Possible values: <= 500 characters

    registryName stringrequired

    Name of charity's registry

    Possible values: <= 255 characters

    registryId stringrequired

    Charity's id in registry

    Possible values: <= 255 characters

    email string

    Possible values: <= 255 characters

    Example: test@goodstack.internal
    addressLine1 string

    Possible values: <= 255 characters

    Example: Testowa street 15
    addressLine2 string

    Possible values: <= 255 characters

    Example: Testowa street 22/15
    city string

    Possible values: <= 255 characters

    Example: Katowice
    postal string

    Possible values: <= 255 characters

    Example: 44-100
    state string

    Possible values: <= 255 characters

    Example: Silesia
    website websiterequired

    Possible values: <= 255 characters

    Example: https://goodstack.internal
    countryCode stringrequired
    Example: POL
    usaGroupExempt boolean

Responses​

Successfully created a Validation Request

Schema

    data

    object

    id string
    Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    name string
    Example: Some charity
    registryName string
    Example: National Charities Registry
    registryId string

    Charity's ID in registry

    Example: I34324
    email emailnullable
    Example: test@percent.internal
    addressLine1 stringnullable
    Example: Testowa street 15
    addressLine2 stringnullable
    Example: Testowa street 22/15
    city stringnullable
    Example: Katowice
    postal stringnullable
    Example: 44-100
    state stringnullable
    Example: Silesia
    website website
    Example: https://percent.internal
    organisationId stringnullable
    Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    countryCode string
    Example: POL
    rejectionReason stringnullabledeprecated

    Reason for rejecting

    Possible values: [Organisation is not a nonprofit., Organisation didn’t provide sufficient proof of nonprofit status., Organisation is a nonprofit but doesn’t have an official registry ID., Other]

    rejectionReasonCode stringnullable

    Reason code for rejecting

    Possible values: [other, not_eligible, incorrect_documentation, not_attributable_to_registry]

    usaGroupExempt booleannullabledeprecated
    createdAt date-time
    Example: 2020-10-13T17:46:54.000Z
    deletedAt date-timenullable
    Example: 2020-10-13T17:46:54.000Z
    acceptedAt date-timenullable
    Example: 2020-10-13T17:46:54.000Z
    rejectedAt date-timenullable
    Example: 2020-10-13T17:46:54.000Z

    documents

    object[]

  • Array [

    • id string
    Example: validationrequestdocument_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    validationRequestId string
    Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    url string
    Example: https://s3-eu-west-1.amazonaws.com/assets.poweredbypercent.com/document.docx
    createdAt date-time
    deletedAt date-timenullable

  • ]

    • organisationTypes string[]

    Possible values: [social_impact, nonprofit]

    object string
    Example: validation_request
Loading...