Create a Validation Request

POST 
/v1/validation-requests

Create a Validation Request

Request

Header Parameters

Idempotency-Key string

Idempotency key

application/json

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

200

Successfully created a Validation Request

application/json

Schema

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

Example (from schema)

{
  "data": {
    "id": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "name": "Some charity",
    "registryName": "National Charities Registry",
    "registryId": "I34324",
    "email": "test@percent.internal",
    "addressLine1": "Testowa street 15",
    "addressLine2": "Testowa street 22/15",
    "city": "Katowice",
    "postal": "44-100",
    "state": "Silesia",
    "website": "https://percent.internal",
    "organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "countryCode": "POL",
    "rejectionReasonCode": "other",
    "usaGroupExempt": true,
    "createdAt": "2020-10-13T17:46:54.000Z",
    "deletedAt": "2020-10-13T17:46:54.000Z",
    "acceptedAt": "2020-10-13T17:46:54.000Z",
    "rejectedAt": "2020-10-13T17:46:54.000Z",
    "documents": [
      {
        "id": "validationrequestdocument_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "url": "https://s3-eu-west-1.amazonaws.com/assets.poweredbypercent.com/document.docx",
        "createdAt": "2024-03-08T11:45:00.829Z",
        "deletedAt": "2024-03-08T11:45:00.829Z"
      }
    ],
    "organisationTypes": [
      "social_impact"
    ]
  },
  "object": "validation_request"
}

400

Bad request

application/json

Schema

Schema

error object
code string
title string
message string
reasons string[]nullable

Example (from schema)

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

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
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}

Loading...