Create a Validation Request

POST 
/v1/validation-requests

Create a Validation Request

Request

Header Parameters

Idempotency-Key string

Idempotency key

application/json

Body

required

namestringrequired

Name of the charity to validate

Possible values: <= 500 characters

registryNamestringrequired

Name of charity's registry

Possible values: <= 255 characters

registryIdstringrequired

Charity's id in registry

Possible values: <= 255 characters

emailstring
Possible values: <= 255 characters
Example: test@goodstack.internal
addressLine1string
Possible values: <= 255 characters
Example: Testowa street 15
addressLine2string
Possible values: <= 255 characters
Example: Testowa street 22/15
citystring
Possible values: <= 255 characters
Example: Katowice
postalstring
Possible values: <= 255 characters
Example: 44-100
statestring
Possible values: <= 255 characters
Example: Silesia
websitewebsiterequired
Possible values: <= 255 characters
Example: https://goodstack.internal
countryCodestringrequired
Example: POL
usaGroupExemptboolean

Responses

200

Successfully created a Validation Request

application/json

Schema

Schema

data

object

idstring

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

Example: Some charity

registryNamestring

Example: National Charities Registry

registryIdstring

Charity's ID in registry

Example: I34324

emailemailnullable

Example: test@percent.internal

addressLine1stringnullable

Example: Testowa street 15

addressLine2stringnullable

Example: Testowa street 22/15

citystringnullable

Example: Katowice

postalstringnullable

Example: 44-100

statestringnullable

Example: Silesia

websitewebsite

Example: https://percent.internal

organisationIdstringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

countryCodestring

Example: POL

rejectionReasonstringnullabledeprecated

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]

rejectionReasonCodestringnullable

Reason code for rejecting

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

usaGroupExemptbooleannullabledeprecated

createdAtdate-time

Example: 2020-10-13T17:46:54.000Z

deletedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

acceptedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

rejectedAtdate-timenullable

Example: 2020-10-13T17:46:54.000Z

documents

object[]

Array [

idstring

Example: validationrequestdocument_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

validationRequestIdstring

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

urlstring

Example: https://s3-eu-west-1.amazonaws.com/assets.poweredbypercent.com/document.docx

createdAtdate-time

deletedAtdate-timenullable

]

organisationTypesstring[]

Possible values: [social_impact, nonprofit]

objectstring
Example: validation_request

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",
    "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-07-29T15:51:28.071Z",
        "deletedAt": "2024-07-29T15:51:28.071Z"
      }
    ],
    "organisationTypes": [
      "social_impact"
    ]
  },
  "object": "validation_request"
}

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]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

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

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