Add a document to a requirement in a CRB's onboarding template response

Add a document to a requirement in a CRB's onboarding template response.

Note - Only documents up to 5MB are supported

You always must include:

  • file_name - Full file name, including the file extension (ex: "statment.pdf")
  • file_type - File mime type, to ensure only allowed types are uploaded. See AllowedS3FileMimeTypes
  • base64 - A base 64 encoded string of the file contents.
Securityaccess_auth
Request
path Parameters
sp_id
required
string^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...

Service Provider Id

crb_id
required
string^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...

CRB Id

requirement_id
required
string

Requirement Id

Request Body schema: application/json
required
file_name
required
string^[^./\\]+\.(csv|docx?|gif|jpe?g|json|odp|ods|...

Full file name, including the file extension

file_type
required
string (AllowedS3FileMimeTypes)
Enum: "text/csv" "application/msword" "application/vnd.openxmlformats-officedocument.wordprocessingml.document" "image/gif" "image/jpeg" "application/json" "application/vnd.oasis.opendocument.presentation" "application/vnd.oasis.opendocument.spreadsheet" "application/vnd.oasis.opendocument.text" "image/png" "application/pdf" "application/vnd.ms-powerpoint" "application/vnd.openxmlformats-officedocument.presentationml.presentation" "application/rtf" "image/svg+xml" "image/tiff" "text/plain" "application/vnd.visio" "application/vnd.ms-excel" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" "application/xml" "text/xml"
base64
required
string

A base 64 encoded string of the file contents.

Responses
200

Ok

401

Unauthorized

403

Forbidden

404

Not Found

422

Validation Failed

put/service-providers/{sp_id}/crbs/{crb_id}/onboarding-template/requirements/{requirement_id}/documents
Request samples
application/json
{
  • "file_name": "string",
  • "file_type": "text/csv",
  • "base64": "string"
}
Response samples
application/json
{
  • "document_id": "string",
  • "updated_requirement_response": {
    }
}