Upload documents to a profile

1 min

POST

https://api.detected.app/api/v2/public/profiles/{uuid}/documents/{libraryId}

Uploads one or more documents to a profile, into the document library given by libraryId. Send the files as multipart/form-data, with each file under a key of the form document_1, document_2 and so on. The response lists the uploaded documents.

uuidstringUUID of the item named in the path, for example the profile in <code>/profiles/{uuid}</code> or the representative in <code>/representatives/{uuid}</code>.

libraryIdintegerID of the document library to upload the documents to. Use <code>GET /documents/libraries</code> to list the libraries.

acceptstringGenerated from available response content types

documentsmapKeyed files: document_1, document_2, ...

200OK. The documents were uploaded, and the response lists them.

400Bad Request. The request could not be processed because it is invalid. The <code>message</code> field explains why.

401Unauthorized. The access token is missing, invalid or has expired.

422Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.

429Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.

curl --request POST \
     --url https://api.detected.app/api/v2/public/profiles/{uuid}/documents/{libraryId} \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data' \
     --form 'documents="map"'

Have a question?

Our knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.