Create Validation Submission Document

POST 
/v1/validation-submission-documents

Uploads a Validation Submission document. Valid file formats for documents are jpg, png and pdf. The maximum file size is 5MB.

Request

Header Parameters

Idempotency-Key string

Idempotency key

multipart/form-data

Body

file binaryrequired

Document to validate. Valid file formats for documents are jpg, png and pdf. The maximum file size is 5MB.

validationSubmissionId stringrequired

Validation submission id

Responses

200

Successfully uploaded Validation Submission document

application/json

Schema

Schema

data object
id string
validationSubmissionId string
createdAt date-time
url url
object string

Example (from schema)

{
  "data": {
    "id": "validationsubmissiondocument_xxxxxxxxxxxx",
    "validationSubmissionId": "validationsubmission_xxxxxxxxxxxx",
    "createdAt": "2022-02-02T17:46:54.000Z",
    "url": "https://s3-eu-west-1.amazonaws.com/assets.poweredbypercent.com/document.pdf"
  },
  "object": "validation_submission_document"
}

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

FiletypeNotSupported

Upload - Filetype not supported

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

FileIsMissing

Upload - File is missing

{
  "error": {
    "code": "upload/file_is_missing",
    "title": "Bad request",
    "message": "File is missing. File is a required field"
  }
}

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

ValidationSubmissionNotFound

400 Bad request

{
  "error": {
    "code": "validation_submission_document/validation_submission_not_found",
    "title": "Bad request",
    "message": "validation submission not found"
  }
}

IncorrectParamsBody

400 Incorrect Parameters

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

InvalidConfiguration

404 Not Found

{
  "error": {
    "code": "validation_submission/invalid_configuration_id",
    "title": "Not Found",
    "message": "Provided configurationId is not valid"
  }
}

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
code string
title string
message string

Example (from schema)

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

Loading...