Start
Search…
Introduction
Core Concepts
Partner setup
Tutorials [WIP]
Public Mint Widget
Getting started
Embed Widget
Public Mint API
Getting started
Creating identities
Connecting to the blockchain
Executing Transactions
Sandbox
API Reference
Transfer Methods
Withdrawals
Verifications
Identity Relations
Identities
Documents
Deposits
Authentication
Pagination
Errors
Core Resources
Public Mint Blockchain
Getting started
Transacting
Configuring Metamask for the Public Mint blockchain
Interoperability [WIP]
Other Information
Public Mint Wallet
Users and Accounts
Powered By GitBook
Identities
The following endpoints are used to insert and retrieve entries representing identities from the database.
IDENTITIES ENDPOINTS
1
POST /identities
2
GET /identities/:id
3
GET /identities
4
GET /identities/:id/deposits
5
GET /identities/:id/withdrawals
6
GET /identities/:id/documents
7
GET /identities/:id/transfer-methods
8
GET /identities/:id/verifications
9
GET /identities/:id/identity-relations
10
POST /identities/:id/kyc-document-check
11
DELETE /identities/:id
Copied!

The identity object

The identity object represents the identity of an individual (or company) in the database.
IDENTITIES OBJECT
1
{
2
"id": "971c3241-9876-471e-b0b3-40040893efd0",
3
"identityOwner": null,
4
"identityType": "person",
5
"verificationStatus": "pending",
6
"blocked": false,
7
"status": "waiting",
8
"companyOfficer": false,
9
"name": "Jonh Doe",
10
"email": "[email protected]",
11
"address": {
12
"city": "Tampa",
13
"state": "AL",
14
"street": "Ochard Street",
15
"country": "US",
16
"postalCode": "12345"
17
},
18
"phone": {
19
"sms": true,
20
"number": "345675643"
21
},
22
"tax": {
23
"state": "FL",
24
"country": "US",
25
"idNumber": "134567890"
26
},
27
"birthday": "1991-12-01T00:00:00.000Z",
28
"gender": "Male",
29
"createdAt": "2021-02-17T11:53:13.199Z",
30
"updatedAt": "2021-02-17T11:53:13.199Z",
31
"deletedAt": null
32
}
Copied!
post
[ENVIRONMENT HOSTNAME]
/identities
POST /identities
​

Example Call

Request
CURL
Response
1
POST [ENVIRONMENT HOSTNAME]/identities
2
​
3
{
4
"name": "Jonh Doe",
5
"email": "[email protected]",
6
"companyOfficer": false,
7
"birthday": "1991-12-01",
8
"gender": "Male",
9
"identityType": "person",
10
"address": {
11
"street": "Ochard Street",
12
"postalCode": "12345",
13
"city": "Tampa",
14
"country": "US",
15
"state": "AL"
16
},
17
"phone": {
18
"number": "345675643",
19
"sms": true
20
},
21
"tax": {
22
"idNumber": "134567890",
23
"state": "FL",
24
"country": "US"
25
}
26
}
Copied!
1
curl --location --request POST 'https://api.tst.publicmint.io/identities' \
2
--header 'Content-Type: application/json' \
3
--header 'apiKey: J8fMImECtv0jAYXJ8D6gS48z45B3YeC5' \
4
--data-raw '{
5
"name": "Jonh Doe",
6
"email": "[email protected]",
7
"companyOfficer": false,
8
"birthday": "1991-12-01",
9
"gender": "Male",
10
"identityType": "person",
11
"address": {
12
"street": "Ochard Street",
13
"postalCode": "12345",
14
"city": "Tampa",
15
"country": "US",
16
"state": "AL"
17
},
18
"phone": {
19
"number": "345675643",
20
"sms": true
21
},
22
"tax": {
23
"idNumber": "134567890",
24
"state": "FL",
25
"country": "US"
26
}
27
}'
Copied!
1
{
2
"id": "971c3241-9876-471e-b0b3-40040893efd0",
3
"identityOwner": null,
4
"identityType": "person",
5
"verificationStatus": "pending",
6
"blocked": false,
7
"status": "waiting",
8
"companyOfficer": false,
9
"name": "Jonh Doe",
10
"email": "[email protected]",
11
"address": {
12
"city": "Tampa",
13
"state": "AL",
14
"street": "Ochard Street",
15
"country": "US",
16
"postalCode": "12345"
17
},
18
"phone": {
19
"sms": true,
20
"number": "345675643"
21
},
22
"tax": {
23
"state": "FL",
24
"country": "US",
25
"idNumber": "134567890"
26
},
27
"birthday": "1991-12-01T00:00:00.000Z",
28
"gender": "Male",
29
"createdAt": "2021-02-17T11:53:13.199Z",
30
"updatedAt": "2021-02-17T11:53:13.199Z",
31
"deletedAt": null
32
}
Copied!
On the Sandbox environment, you can use the approve KYC endpoint to simulate and approve or reject the identity you created.
get
[ENVIRONMENT HOSTNAME]
/identities/:id
GET /identities/:id

​

Example Call

Request
CURL
Response
1
GET [ENVIRONMENT HOSTNAME]/identities/971c3241-9876-471e-b0b3-40040893efd0
Copied!
1
curl -X GET \
2
[ENVIRONMENT HOSTNAME]/identities/e65dde2c-4379-42c7-a665-3f476cebb691 \
3
-H 'apikey: {INSERT YOUR API KEY HERE}' \
Copied!
1
{
2
"id": "e65dde2c-4379-42c7-a665-3f476cebb691",
3
"identityOwner": null,
4
"identityType": "person",
5
"verificationStatus": "pending",
6
"blocked": false,
7
"status": "active",
8
"companyOfficer": false,
9
"name": "Jonh Doe",
10
"email": "[email protected]",
11
"address": {
12
"city": "Tampa",
13
"state": "AL",
14
"street": "Ochard Street",
15
"country": "US",
16
"postalCode": "12345"
17
},
18
"phone": {
19
"sms": true,
20
"number": "345675643"
21
},
22
"tax": {
23
"state": "FL",
24
"country": "US",
25
"idNumber": "134567890"
26
},
27
"birthday": "1991-12-01T00:00:00.000Z",
28
"gender": "Male",
29
"createdAt": "2020-02-19T11:04:59.345Z",
30
"updatedAt": "2020-02-19T11:05:00.644Z",
31
"deletedAt": null
32
}
Copied!
get
[ENVIRONMENT HOSTNAME]
/identities
GET /identities
​

Example Call

Request
CURL
Response
1
GET [ENVIRONMENT HOSTNAME]/identities
2
​
3
// PAGINATED
4
​
5
GET [ENVIRONMENT HOSTNAME]/identities?page[number]=1&page[size]=1
Copied!
1
curl -X GET \
2
[ENVIRONMENT HOSTNAME]/identities \
3
-H 'apikey: {INSERT YOUR API KEY HERE}'
Copied!
1
{
2
"total": 1,
3
"data": [{
4
"id": "971c3241-9876-471e-b0b3-40040893efd0",
5
"identityOwner": null,
6
"identityType": "person",
7
"verificationStatus": "pending",
8
"blocked": false,
9
"status": "active",
10
"companyOfficer": false,
11
"name": "Jonh Doe",
12
"email": "[email protected]",
13
"address": {
14
"city": "Tampa",
15
"state": "AL",
16
"street": "Ochard Street",
17
"country": "US",
18
"postalCode": "12345"
19
},
20
"phone": {
21
"sms": true,
22
"number": "345675643"
23
},
24
"tax": {
25
"state": "FL",
26
"country": "US",
27
"idNumber": "134567890"
28
},
29
"birthday": "1991-12-01T00:00:00.000Z",
30
"gender": "Male",
31
"createdAt": "2021-02-17T11:53:13.199Z",
32
"updatedAt": "2021-02-17T11:53:14.484Z",
33
"deletedAt": null
34
}]
35
}
Copied!
get
[ENVIRONMENT HOSTNAME]
/identities/:id/deposits
GET /identities/:id/deposits
​

Example Call

Request
Curl
Response
1
GET [ENVIRONMENT HOSTNAME]/identities/971c3241-9876-471e-b0b3-40040893efd0/deposits
Copied!
1
curl -X GET \
2
[ENVIRONMENT HOSTNAME]/identities/971c3241-9876-471e-b0b3-40040893efd0/deposits \
3
-H 'apikey: {INSERT API KEY HERE}'
Copied!
1
{
2
"total": 1,
3
"data": [{
4
"id": "730de6f9-c77d-40a4-82d4-193394e1e571",
5
"identityId": "971c3241-9876-471e-b0b3-40040893efd0",
6
"amount": "12",
7
"currency": "USD",
8
"blockchainAddress": "0x359f194ce353b1415abff5fcb07baf59f0bda0de",
9
"transferMethodInformation": {
10
"transferType": "wire"
11
},
12
"status": "waiting",
13
"reference": null,
14
"createdAt": "2021-02-17T12:03:11.871Z",
15
"updatedAt": "2021-02-17T12:03:11.871Z"
16
}]
17
}
Copied!
get
[ENVIRONMENT HOSTNAME]
/identities/:id/withdrawals
GET /identities/:id/withdrawals

​

Example Call

Request
Curl
Response
1
GET [ENVIRONMENT HOSTNAME]/identities/7c8867d7-b9b8-40de-86c7-f4a8e4ee566d/withdrawals
2
​
3
// PAGINAT£D
4
​
5
GET [ENVIRONMENT HOSTNAME]/identities/7c8867d7-b9b8-40de-86c7-f4a8e4ee566d/withdrawals?page[number]=1&page[size]=1
Copied!
1
curl -X GET \
2
[ENVIRONMENT HOSTNAME]/identities/5b145407-ebca-474c-92be-a0a5c577f1aa/withdrawals \
3
-H 'apikey: {INSERT API KEY HERE}'
Copied!
1
{
2
"total": 1,
3
"data": [
4
{
5
"id": "2642dedd-4fa0-40bf-8b15-7c0513bcdb38",
6
"identityId": "e65dde2c-4379-42c7-a665-3f476cebb691",
7
"transferType": "ach",
8
"transactionReference": "0xbba8f98772463079ed98826507b5accc0180220ef45641e6d882d43260a082f7",
9
"blockchainAddress": "0x8ba13aB181E9F30e543C6376Cd408192E95bCD1C",
10
"amount": null,
11
"currency": "USD",
12
"transactionHash": null,
13
"transferMethodId": "ce953d97-4e41-4396-8626-12d07914c045",
14
"status": "prepared",
15
"createdAt": "2020-02-19T11:43:04.553Z",
16
"updatedAt": "2020-02-19T11:43:04.553Z"
17
}
18
]
19
}
20
​
21
​
22
​
Copied!
get
[ENVIRONMENT HOSTNAME]
/identities/:id/documents
GET /identities/:id/documents
​

Example Call

Request
Curl
Response
1
GET [ENVIRONMENT HOSTNAME]/identities/32634b13-c370-4e77-afbc-2841d9d4b760/documents
2
3
// PAGINATED
4
5
GET [ENVIRONMENT HOSTNAME]/identities/32634b13-c370-4e77-afbc-2841d9d4b760/documents?page[number]=1&page[size]=1
Copied!
1
curl -X GET \
2
[ENVIRONMENT HOSTNAME]/identities/5f5e13fb-c5d7-488b-923b-278b96b138b9/documents \
3
-H "apikey: {INSERT YOUR API KEY HERE}" \
Copied!
1
{
2
"total": 1,
3
"data": [
4
{
5
"id": "6215e0aa-dde7-40ac-af3b-b6fa733529ff",
6
"identityId": "e65dde2c-4379-42c7-a665-3f476cebb691",
7
"status": "active",
8
"label": "identity card",
9
"description": "identity card of jonh smith",
10
"extension": ".jpg",
11
"fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e6/5d/de/2c/tLHGdo6z3PgOp4lR.jpeg",
12
"documentType": "IdentityCard",
13
"documentSide": "FrontSide",
14
"createdAt": "2020-02-19T15:15:23.546Z",
15
"updatedAt": "2020-02-19T15:15:24.864Z",
16
"deletedAt": null
17
}
18
]
19
}
Copied!
get
[ENVIRONMENT HOSTNAME]
/identities/:id/verifications
GET /identities/:id/verifications
​

Example Call

Request
Curl
Response
1
GET [ENVIRONMENT HOSTNAME]/identities/74418597-9bc9-4791-aadc-8993961509c9/verifications
2
​
3
// PAGINATED
4
​
5
GET [ENVIRONMENT HOSTNAME]/identities/74418597-9bc9-4791-aadc-8993961509c9/verifications?page[number]=1&page[size]=1
Copied!
1
curl -X GET \
2
[ENVIRONMENT HOSTNAME]/identities/5b145407-ebca-474c-92be-a0a5c577f1aa/verifications \
3
-H 'apikey: {INSERT API KEY HERE}'
Copied!
1
{
2
"total": 4,
3
"data": [
4
{
5
"id": "c0f38c55-3d93-4799-b3e9-da7ba195ab1e",
6
"identityId": "e65dde2c-4379-42c7-a665-3f476cebb691",
7
"status": "approved",
8
"exceptionDetails": "",
9
"createdAt": "2020-02-19T11:05:07.750Z",
10
"updatedAt": "2020-02-19T11:42:57.138Z"
11
},
12
{
13
"id": "7116651f-bf20-4a73-9f0a-b61d3e72568f",
14
"identityId": "e65dde2c-4379-42c7-a665-3f476cebb691",
15
"status": "approved",
16
"exceptionDetails": "",
17
"createdAt": "2020-02-19T11:05:07.760Z",
18
"updatedAt": "2020-02-19T11:42:57.248Z"
19
},
20
{
21
"id": "20c1fdd8-675f-4c88-b7ef-740db119c3d4",
22
"identityId": "e65dde2c-4379-42c7-a665-3f476cebb691",
23
"status": "approved",
24
"exceptionDetails": "",
25
"createdAt": "2020-02-19T11:05:07.853Z",
26
"updatedAt": "2020-02-19T11:42:57.462Z"
27
},
28
{
29
"id": "9ad2b23a-c2f0-4f80-af5c-0deb7a0a57e6",
30
"identityId": "e65dde2c-4379-42c7-a665-3f476cebb691",
31
"status": "approved",
32
"exceptionDetails": "",
33
"createdAt": "2020-02-19T11:05:07.955Z",
34
"updatedAt": "2020-02-19T11:42:57.644Z"
35
}
36
]
37
}
Copied!
get
[ENVIRONMENT HOSTNAME]
/identities/:id/transfer-methods
GET /identities/:id/transfer-methods
​

Example Call

Request
Curl
1
GET [ENVIRONMENT HOSTNAME]/identities/e0564926-96e0-42e2-a544-68bc18598e40/transfer-methods
2
​
3
// PAGINATED
4
​
5
GET [ENVIRONMENT HOSTNAME]/identities/e0564926-96e0-42e2-a544-68bc18598e40/transfer-methods?page[number]=1&page[size]=1
Copied!
1
curl --location --request GET 'https://api.tst.publicmint.io/identities/e0564926-96e0-42e2-a544-68bc18598e40/transfer-methods' \
2
--header 'apikey: {INSERT YOUR API KEY HERE}'
Copied!
get
[ENVIRONMENT HOSTNAME]
/identities/:id/identity-relations
GET /identities/:id/identity-relations
​
Example call
Request
Curl
Response
1
GET [ENVIRONMENT HOSTNAME]/identities/577b2ebc-4d08-42fc-9217-46eae3bb2426/identity-relations
Copied!
1
curl -X GET \
2
[ENVIRONMENT HOSTNAME]/identities/577b2ebc-4d08-42fc-9217-46eae3bb2426/identity-relations \
3
-H 'Content-Type: application/json' \
4
-H 'apikey: {INSERT YOUR API KEY HERE}'
Copied!
1
{
2
"total": 1,
3
"data": [
4
{
5
"id": "b28d7969-ff31-435a-a173-469d6136da4c",
6
"appId": "f3f8f171-975a-436d-9c7f-92f2fb145385",
7
"fromIdentity": "577b2ebc-4d08-42fc-9217-46eae3bb2426",
8
"toIdentity": "f51c7041-fdab-4f03-acaf-9c34df178724",
9
"label": "CEO"
10
}
11
]
12
​
Copied!
post
[ENVIRONMENT HOSTNAME]
/identities/:id/kyc-documn
POST /identities/:id/kyc-document-check
​
Example call
Request
Curl
Response
1
POST [ENVIRONMENT HOSTNAME]/identities/577b2ebc-4d08-42fc-9217-46eae3bb2426/kyc-document-check
Copied!
1
curl --location --request POST 'https://api.tst.publicmint.io/identities/e0564926-96e0-42e2-a544-68bc18598e40/kyc-document-check' \
2
--header 'Content-Type: application/json' \
3
--header 'apikey: {INSERT YOUR API KEY HERE}'
Copied!
1
{
2
"id": "6215e0aa-dde7-40ac-af3b-b6fa733529ff",
3
"identityId": "e65dde2c-4379-42c7-a665-3f476cebb691",
4
"status": "active",
5
"label": "identity card",
6
"description": "identity card of jonh smith",
7
"extension": ".jpg",
8
"fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e6/5d/de/2c/tLHGdo6z3PgOp4lR.jpeg",
9
"documentType": "IdentityCard",
10
"documentSide": "FrontSide",
11
"createdAt": "2020-02-19T15:15:23.546Z",
12
"updatedAt": "2020-02-19T15:15:24.864Z",
13
"deletedAt": null
14
}
Copied!
delete
[ENVIRONMENT HOSTNAME]
/identities/:id
DELETE /identities/:id
​
Previous
Identity Relations
Next
Documents
Last modified 11mo ago
Copy link
Contents
The identity object
post
POST /identities
get
GET /identities/:id
get
GET /identities
get
GET /identities/:id/deposits
get
GET /identities/:id/withdrawals
get
GET /identities/:id/documents
get
GET /identities/:id/verifications
get
GET /identities/:id/transfer-methods
get
GET /identities/:id/identity-relations
post
POST /identities/:id/kyc-document-check
delete
DELETE /identities/:id