Create a Validation Request Document

POST 
/v1/validation-requests/:validationRequestId/document

Uploads a document and updates the Validation Request to refer to that document. Valid file formats for documents are jpg, png and pdf. The maximum file size is 5MB.

Request

Path Parameters

validationRequestId stringrequired

Id of the Validation Request to add a document to

Header Parameters

Idempotency-Key string

Idempotency key

multipart/form-data

Body

string

Responses

200

Successfully uploaded document and updated 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.831Z",
        "deletedAt": "2024-03-08T11:45:00.831Z"
      }
    ],
    "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"
    ]
  }
}

MultipartBoundaryNotFound

Upload - Multipart boundary not found

{
  "error": {
    "code": "upload/multipart_boundary_not_found",
    "title": "Bad request",
    "message": "Please provide multipart boundary"
  }
}

TooManyAttachments

Upload - Too many attachments

{
  "error": {
    "code": "upload/too_many_files",
    "title": "Bad request",
    "message": "Too many files attached (max: 1)"
  }
}

ContentTypeError

Upload - Content type error

{
  "error": {
    "code": "upload/content_type_error",
    "title": "Bad request",
    "message": "Unsupported content type: xls"
  }
}

MaxFileSize

Upload - File exceeded max size

{
  "error": {
    "code": "upload/max_file_size",
    "title": "Bad request",
    "message": "Request size exceeded maximum for this endpoint (5242880 bytes)"
  }
}

FiletypeNotSupported

Upload - Filetype not supported

{
  "error": {
    "code": "upload/filetype_not_supported",
    "title": "Bad request",
    "message": "Filetype not supported.  Supported types include: pdf, png, jpg"
  }
}

BadRequest

400 Bad Request

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "Something is wrong with your request, please check any parameters and try again"
  }
}

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...