# Person documents

## Create a document for a person

 - [POST /v1/persons/{person_id}/documents](https://docs.solarisgroup.com/api-reference/onboarding/persons/person-documents/paths/~1v1~1persons~1%7Bperson_id%7D~1documents/post.md): Uploads a document and links it to the person specified in the request URL. Unlike most other endpoints, this request uses the  of . You must submit the parameters as  items instead of a raw JSON body. By default, uploaded documents are not accessible to customers (i.e., the  value is set to ).

## Index a person's documents

 - [GET /v1/persons/{person_id}/documents](https://docs.solarisgroup.com/api-reference/onboarding/persons/person-documents/paths/~1v1~1persons~1%7Bperson_id%7D~1documents/get.md): Returns an array containing all documents linked to the person specified in the request URL.

## Download a document

 - [GET /v1/persons/{person_id}/documents/{id}/file](https://docs.solarisgroup.com/api-reference/onboarding/persons/person-documents/paths/~1v1~1persons~1%7Bperson_id%7D~1documents~1%7Bid%7D~1file/get.md): Returns the binary file related to the document specified in the request URL.

## Retrieve metadata about a document

 - [GET /v1/persons/{person_id}/documents/{id}](https://docs.solarisgroup.com/api-reference/onboarding/persons/person-documents/paths/~1v1~1persons~1%7Bperson_id%7D~1documents~1%7Bid%7D/get.md): Returns metadata about a person's document, including the filename and type.

## Update a person document's attributes

 - [PATCH /v1/persons/{person_id}/documents/{id}](https://docs.solarisgroup.com/api-reference/onboarding/persons/person-documents/paths/~1v1~1persons~1%7Bperson_id%7D~1documents~1%7Bid%7D/patch.md): Updates the  and/or  attributes on a document.

## Delete a document

 - [DELETE /v1/persons/{person_id}/documents/{id}](https://docs.solarisgroup.com/api-reference/onboarding/persons/person-documents/paths/~1v1~1persons~1%7Bperson_id%7D~1documents~1%7Bid%7D/delete.md): Marks a document as deleted.

## Upload documents for a person identification

 - [POST /v1/persons/{person_id}/identifications/{id}/document_upload](https://docs.solarisgroup.com/api-reference/onboarding/persons/person-documents/paths/~1v1~1persons~1%7Bperson_id%7D~1identifications~1%7Bid%7D~1document_upload/post.md): Uploads an identification document for the person identification specified in the request URL. Note that this request uses the  of  and that the request body must be submitted as individual  items.

## Index documents for a person identification

 - [GET /v1/persons/{person_id}/identifications/{id}/documents](https://docs.solarisgroup.com/api-reference/onboarding/persons/person-documents/paths/~1v1~1persons~1%7Bperson_id%7D~1identifications~1%7Bid%7D~1documents/get.md): Returns all documents uploaded to the person identification specified in the request URL.

## (Sandbox only) Trigger account block or send notification due to outdated identity document

 - [POST /v1/persons/{id}/test_id_document_update](https://docs.solarisgroup.com/api-reference/onboarding/persons/person-documents/paths/~1v1~1persons~1%7Bid%7D~1test_id_document_update/post.md): Checks the expiration date of a person's identity document and then either triggers an account block (if the document has expired) or sends a notification that the document is about to expire. Only available on Sandbox for testing purposes.