Upload

POST https://public-api.use1.lawgeex.com/document/v1/upload

This endpoint allows you to upload a document. For European accounts you can use https://public-api.euc1.lawgeex.com

Headers

Name	Type	Description
x-api-key	string	Authentication Token

Request Body

Name	Type	Description
documentBinary	string	The zipped document content in base64 string. Allowed extensions: .doc/.docx/.pdf Max size: 50MB
fileName	string	File name with extension. This is a way to change the name of the document.
extDocId	string	The external document ID in the external system. Should not contain /:?#[]@!$&'()*+,:= or exceed 50 characters.
playbookId	string	The LawGeex Playbook ID that will be used for this document and will be provided by your LawGeex customer success manager. In case no email was provided, the account's default will be used.
uploaderEmail	string	The email address of the user/lawyer that will be registered as the uploader of the document. In case no email was provided, the account's default will be registered.
reviewResultsEmail	array	Once the document is ready, an email notification will be sent to the added email addresses in "reviewResultsEmail". In case no email was added, the notification will be sent to the account's default email addresses if any.
rejectEmail	array	In case upload fails an email notification will be sent to the added email addresses in "rejectEmail". In case no email was added, the notification will be sent to the account's default email addresses. In case the account has no default, the notification will be sent to the added email address in "uploaderEmail" if added.
reviewNote	string	Displayed internally and sent back to the customer. Format: "<key1>:<value1>\n<key2>:<value2>"

200 Document successfully uploaded.

{
 "docId": "db3a98e7-b4b3-42c3-8cfb-25ac1abead90"
}

400 Bad Request (Missing mandatory fields or invalid fields types)

{
   "message":"body must have required property 'documentBinary'",
   "code" : "BAD_REQUEST"
}

422 Request is valid but server is unable to process it. For example:

{
   "message":"Playbook X does not exist",
   "code" : "MISSING_PLAYBOOK"
}

500 The server encountered an unexpected condition that prevented it from fulfilling the request.

{
    "message": "Internal Server Error",
    "code": "INTERNAL_SERVER_ERROR"
}

Response Field	Type	Description
docId	string	LawGeex document ID