Create a Validation Request
POST/v1/validation-requests
Create a Validation Request
Request​
Header Parameters
Idempotency key
- application/json
Body
required
Possible values: <= 500 characters
Name of the charity to validate
Possible values: <= 255 characters
Name of charity's registry
Possible values: <= 255 characters
Charity's id in registry
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Responses​
- 200
- 400
- 401
- 403
Successfully created a Validation Request
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data object
Charity's ID in registry
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
Possible values: [other
, not_eligible
, incorrect_documentation
, not_attributable_to_registry
]
Reason code for rejecting
documents object[]
Possible values: [social_impact
, nonprofit
]
{
"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"
}
Bad request
- application/json
- Schema
- Example (from schema)
- OriginalCallInProgress
- SameKeyDifferentData
- KeyInUse
Schema
error object
{
"error": {
"code": "string",
"title": "string",
"message": "string",
"reasons": [
"string"
]
}
}
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"
}
}
Idempotency - Data has changed from previous request
{
"error": {
"code": "idempotency/same_key_different_data",
"title": "Bad request",
"message": "Data has changed from previous request"
}
}
Idempotency - Key in use
{
"error": {
"code": "idempotency/key_already_in_use",
"title": "Bad request",
"message": "Idempotency Key is already in use"
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}