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

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

name string

Example: Some charity

registryName string

Example: National Charities Registry

registryId string

Charity's ID in registry

Example: I34324

email emailnullable

Example: test@percent.internal

addressLine1 stringnullable

Example: Testowa street 15

addressLine2 stringnullable

Example: Testowa street 22/15

city stringnullable

Example: Katowice

postal stringnullable

Example: 44-100

state stringnullable

Example: Silesia

website website

Example: https://percent.internal

organisationId stringnullable

Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

countryCode string

Example: POL

rejectionReason stringnullabledeprecated

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]

rejectionReasonCode stringnullable

Reason code for rejecting

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

usaGroupExempt booleannullabledeprecated

createdAt date-time

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

deletedAt date-timenullable

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

acceptedAt date-timenullable

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

rejectedAt date-timenullable

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

documents

object[]

Array [

id string

Example: validationrequestdocument_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

validationRequestId string

Example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

url string

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

createdAt date-time

deletedAt date-timenullable

]

organisationTypes string[]

Possible values: [social_impact, nonprofit]

object string
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

Error validating inputs

application/json

Schema

Schema

error

object

code string

Example: bad_request

title string

Example: Bad request

message string

Example: One or more of the inputs were invalid

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

Example: forbidden

title string

Example: Forbidden

message string

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

404

The specified resource was not found

application/json

Schema

Schema

error

object

code string

Example: not_found

title string

Example: Resource not found

message string

Example: This endpoint is unavailable or can not be found

Example (from schema)

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

Loading...