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

    Possible values: <= 500 characters

    Name of the charity to validate

    registryName stringrequired

    Possible values: <= 255 characters

    Name of charity's registry

    registryId stringrequired

    Possible values: <= 255 characters

    Charity's id in registry

    email string

    Possible values: <= 255 characters

    addressLine1 string

    Possible values: <= 255 characters

    addressLine2 string

    Possible values: <= 255 characters

    city string

    Possible values: <= 255 characters

    postal string

    Possible values: <= 255 characters

    state string

    Possible values: <= 255 characters

    website websiterequired

    Possible values: <= 255 characters

    countryCode stringrequired
    usaGroupExempt boolean

Responses​

Successfully created a Validation Request

Schema
    data object
    id string
    name string
    registryName string
    registryId string

    Charity's ID in registry

    email emailnullable
    addressLine1 stringnullable
    addressLine2 stringnullable
    city stringnullable
    postal stringnullable
    state stringnullable
    website website
    organisationId stringnullable
    countryCode string
    rejectionReason stringnullabledeprecated

    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]

    Reason for rejecting

    rejectionReasonCode stringnullable

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

    Reason code for rejecting

    usaGroupExempt booleannullable
    createdAt date-time
    deletedAt date-timenullable
    acceptedAt date-timenullable
    rejectedAt date-timenullable
    documents object[]
  • Array [
  • id string
    validationRequestId string
    url string
    createdAt date-time
    deletedAt date-timenullable
  • ]
  • organisationTypes string[]

    Possible values: [social_impact, nonprofit]

    object string
Loading...