Retrieve a Validation Request

GET 
/v1/validation-requests/:id

Retrieve a Validation Request

Request

Path Parameters

id stringrequired

Id of the Validation Request.

Responses

200

Successfully retrieved 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.830Z",
        "deletedAt": "2024-03-08T11:45:00.830Z"
      }
    ],
    "organisationTypes": [
      "social_impact"
    ]
  },
  "object": "validation_request"
}

400

Error validating inputs

application/json

Schema

Schema

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

Example (from schema)

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

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"
  }
}

404

The specified resource was not found

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}

Loading...