Upload a file for a company provided document.
Changed onUpload a file to the upload_url of the associated company provided document.
put/company_provided_documents/{document}/upload
Request
- Base URLhttps://sandbox.checkhq.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
documentstring required
ID of the company provided document to associate the uploaded file with.
Headers
Content-Type'application/pdf' | 'image/jpeg' | 'image/png'
Request body
Response
200
Example response
{
"id": "doc_1fyTzNTwEg1gWwKOqYK9",
"company": "com_kGYEICK22GEzj8trreH3",
"document_type": "940",
"upload_url": "https://sandbox.checkhq.com/company_provided_documents/doc_1fyTzNTwEg1gWwKOqYK9/upload",
"upload_status": "uploaded",
"file_content_type": "application/pdf",
"provided_filename": "sample_document.pdf"
}Changes
- info
endpoint added
- info