Update document
curl --request PATCH \
--url https://api.entendre.finance/v1/vault/documents/{document_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"filename": "<string>",
"file_directory": "<string>"
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({filename: '<string>', file_directory: '<string>'})
};
fetch('https://api.entendre.finance/v1/vault/documents/{document_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.entendre.finance/v1/vault/documents/{document_id}"
payload = {
"filename": "<string>",
"file_directory": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "doc_6f31e8c4-41ce-47af-9db7-3ad295a0a601",
"organization_id": "org_123",
"document_type": "statement",
"document_source": "upload",
"file_size": 1,
"filename": "august-statement.pdf",
"original_filename": null,
"file_extension": "pdf",
"summary": null,
"confidence_level": 1,
"language": null,
"created_at": null,
"deleted_at": null,
"download_url": "https://files.example.com/documents/statement.pdf"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid path, query or request body.",
"request_id": "req_example"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"request_id": "req_example"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient access to organization",
"request_id": "req_example"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"request_id": "req_example"
}
}{
"error": {
"code": "CONFLICT",
"message": "The resource state does not allow this operation.",
"request_id": "req_example"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 30s.",
"request_id": "req_example"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error",
"request_id": "req_example"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service unavailable.",
"request_id": "req_example"
}
}Documents
Update document
Renames a document or moves it to another folder.
PATCH
/
v1
/
vault
/
documents
/
{document_id}
Update document
curl --request PATCH \
--url https://api.entendre.finance/v1/vault/documents/{document_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"filename": "<string>",
"file_directory": "<string>"
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({filename: '<string>', file_directory: '<string>'})
};
fetch('https://api.entendre.finance/v1/vault/documents/{document_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.entendre.finance/v1/vault/documents/{document_id}"
payload = {
"filename": "<string>",
"file_directory": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "doc_6f31e8c4-41ce-47af-9db7-3ad295a0a601",
"organization_id": "org_123",
"document_type": "statement",
"document_source": "upload",
"file_size": 1,
"filename": "august-statement.pdf",
"original_filename": null,
"file_extension": "pdf",
"summary": null,
"confidence_level": 1,
"language": null,
"created_at": null,
"deleted_at": null,
"download_url": "https://files.example.com/documents/statement.pdf"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid path, query or request body.",
"request_id": "req_example"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"request_id": "req_example"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Insufficient access to organization",
"request_id": "req_example"
}
}{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"request_id": "req_example"
}
}{
"error": {
"code": "CONFLICT",
"message": "The resource state does not allow this operation.",
"request_id": "req_example"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 30s.",
"request_id": "req_example"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error",
"request_id": "req_example"
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service unavailable.",
"request_id": "req_example"
}
}Authorizations
Your organization API key. Some operations also need a key that is associated with a user; their pages say so.
Path Parameters
ID of the document.
Minimum string length:
1Body
application/json
Response
The request succeeded.
A document. id is doc_<uuid>.
Show child attributes
Show child attributes