A person can have documents stored against their record. These end points allow person documents to be retrieved and added to a person record
Get Document by ID
Get a Document by ID
SecuritybearerAuth
Request
Responses
200
Document Response
400
Bad Request
401
Unauthorized - Authorization Required
404
Not Found
422
Unprocessable Entity
default
General Error
get/documents/{id}
Request samples
- curl
- C#
- Java
- PHP
Response samples
- 200
- 400
- 401
- 404
- 422
- default
application/vnd.api+json
{- "data": {
- "0": {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}, - "type": "document",
- "attributes": {
- "fileName": "test.pdf",
- "base64Contents": "AQ=="
}, - "relationships": {
- "person": {
}
}, - "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}Add a Document
Add a Document to a Person
SecuritybearerAuth
Request
Request Body schema: application/vnd.api+json
Document to be added
object |
Responses
200
Document Response
400
Bad Request
401
Unauthorized - Authorization Required
422
Unprocessable Entity
default
General Error
post/documents
Request samples
- Payload
- curl
- C#
- Java
- PHP
application/vnd.api+json
{- "data": {
- "type": "Document",
- "attributes": {
- "fileName": "test.pdf",
- "base64Contents": "AQ=="
}, - "relationships": {
- "0": null,
- "person": {
- "data": {
- "id": "285f0a36-9ff3-4399-a47a-80e9bce56921",
- "type": "people"
}
}
}
}
}Response samples
- 200
- 400
- 401
- 422
- default
application/vnd.api+json
{- "data": {
- "0": {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}, - "type": "document",
- "attributes": {
- "fileName": "test.pdf",
- "base64Contents": "AQ=="
}, - "relationships": {
- "person": {
}
}, - "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}