Documents

This resource corresponds to a digitized document hosted on Public Mint's servers in file format.

ENDPOINTS

POST /documents
GET /documents/:id
GET /documents
DELETE /documents/:id

The document object

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.

DOCUMENT OBJECT

{
    "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 /documents

POST [ENVIRONMENT HOSTNAME]/documents

This endpoint allows you to submit a new document to the database. If all parameters are valid, a new record will be added to the database.

Request Body

Name	Type	Description
description	string	Description associated to the document
documentSide	string	Side of the document Must be one of the following: - FrontSide - BackSide
documentType	string	Type of the document Must be one of the following: - IdentityCard; - DriverLicense; - Passport; - ResidencePermit; - UtilityBill; - Other.
identityId	string	Id of the identity associated to the document.
label	string	Label for the document.
file	object	Document file Requirements: - Needs to be a file; - Needs to be the last field in the form

200 Deposit successfully inserted in the database.

{
    "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
}

Example Call

Request

POST [ENVIRONMENT HOSTNAME]/documents

Curl

Response

GET /documents/:id

GET [ENVIRONMENT HOSTNAME]/documents/:id

This endpoint retrieves a single document that you own by its specific id attribute.

Path Parameters

Name	Type	Description
id	string	Id of the document to be retrieved

200

{
    "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
}

Example Call

Request

GET [ENVIRONMENT HOSTNAME]/documents/0acb6a86-e21e-45d6-a4e5-70bd4f85ecae

Curl

Response

GET /documents

GET [ENVIRONMENT HOSTNAME]/documents

This endpoint returns a list of all documents submitted by you.

200

{
    "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
        }
    ]
}

Example Call

Request

GET [ENVIRONMENT HOSTNAME]/documents
  
// PAGINATED

GET [ENVIRONMENT HOSTNAME]/documents?page[number]=1&page[size]=1

Curl

Response

DELETE /documents/:id

DELETE [ENVIRONMENT HOSTNAME]/documents/:id

Deletes a specific document by it's id.

Path Parameters

Name	Type	Description
id	string	Document id

204