This resource corresponds to a digitized document hosted on Public Mint's servers in file
format.
POST /documentsGET /documents/:idGET /documentsDELETE /documents/:id
The document
object represents a digitized document (generally a government ID or proof of address) in the shape of a file uploaded to Public Mint's servers.
A document
is identified by a unique, random id
and relates to a user's identityId
.
{"id": "e9cbc096-bb79-438b-93ac-7c15dfdb1274","identityId": "971c3241-9876-471e-b0b3-40040893efd0","status": "pending","label": "identity card","description": "identity card of jonh smith","extension": ".png","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/97/1c/32/41/LaDRHrVEScopeYBT.png","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2021-02-17T14:03:51.974Z","updatedAt": "2021-02-17T14:03:51.974Z","deletedAt": null}
{"id": "e9cbc096-bb79-438b-93ac-7c15dfdb1274","identityId": "971c3241-9876-471e-b0b3-40040893efd0","status": "pending","label": "identity card","description": "identity card of jonh smith","extension": ".png","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/97/1c/32/41/LaDRHrVEScopeYBT.png","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2021-02-17T14:03:51.974Z","updatedAt": "2021-02-17T14:03:51.974Z","deletedAt": null}
​
POST [ENVIRONMENT HOSTNAME]/documents​​
curl --location --request POST 'https://api.tst.publicmint.io/documents' \--header 'apiKey: J8fMImECtv0jAYXJ8D6gS48z45B3YeC5' \--form 'description="identity card of jonh smith"' \--form 'label="identity card"' \--form 'identityId="971c3241-9876-471e-b0b3-40040893efd0"' \--form 'documentType="IdentityCard"' \--form 'documentSide="FrontSide"' \--form 'file=@"/Users/foo/Screen Shot 2021-02-04 at 14.33.01.png"'
{"id": "e9cbc096-bb79-438b-93ac-7c15dfdb1274","identityId": "971c3241-9876-471e-b0b3-40040893efd0","status": "pending","label": "identity card","description": "identity card of jonh smith","extension": ".png","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/97/1c/32/41/LaDRHrVEScopeYBT.png","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2021-02-17T14:03:51.974Z","updatedAt": "2021-02-17T14:03:51.974Z","deletedAt": null}
id
attribute.{"id": "0acb6a86-e21e-45d6-a4e5-70bd4f85ecae","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","label": "identity card","description": "identity card of jonh smith","extension": ".jpeg","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e0/56/49/26/N5MXjSIhK0bGAOt2.jpeg","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2020-01-10T17:24:23.561Z","updatedAt": "2020-01-10T17:24:24.455Z","deletedAt": null}
​
GET [ENVIRONMENT HOSTNAME]/documents/0acb6a86-e21e-45d6-a4e5-70bd4f85ecae​
curl -X GET \[ENVIRONMENT HOSTNAME]/documents/0acb6a86-e21e-45d6-a4e5-70bd4f85ecae \-H "apikey: {INSERT YOUR API KEY HERE}" \
{"id": "0acb6a86-e21e-45d6-a4e5-70bd4f85ecae","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","label": "identity card","description": "identity card of jonh smith","extension": ".jpeg","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e0/56/49/26/N5MXjSIhK0bGAOt2.jpeg","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2020-01-10T17:24:23.561Z","updatedAt": "2020-01-10T17:24:24.455Z","deletedAt": null}
{"total": 1,"data": [{"id": "0acb6a86-e21e-45d6-a4e5-70bd4f85ecae","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","label": "identity card","description": "identity card of jonh smith","extension": ".jpeg","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e0/56/49/26/N5MXjSIhK0bGAOt2.jpeg","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2020-01-10T17:24:23.561Z","updatedAt": "2020-01-10T17:24:24.455Z","deletedAt": null}]}
​
GET [ENVIRONMENT HOSTNAME]/documents// PAGINATED​GET [ENVIRONMENT HOSTNAME]/documents?page[number]=1&page[size]=1
curl -X GET \"[ENVIRONMENT HOSTNAME]/documents" \-H "apikey: {INSERT YOUR API KEY HERE}" \
{"total": 1,"data": [{"id": "0acb6a86-e21e-45d6-a4e5-70bd4f85ecae","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","label": "identity card","description": "identity card of jonh smith","extension": ".jpeg","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e0/56/49/26/N5MXjSIhK0bGAOt2.jpeg","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2020-01-10T17:24:23.561Z","updatedAt": "2020-01-10T17:24:24.455Z","deletedAt": null}]}
​
​