The following endpoints are used to insert and retrieve entries representing identities
from the database.
POST /identitiesGET /identities/:idGET /identitiesGET /identities/:id/depositsGET /identities/:id/withdrawalsGET /identities/:id/documentsGET /identities/:id/transfer-methodsGET /identities/:id/verificationsGET /identities/:id/identity-relationsPOST /identities/:id/kyc-document-checkDELETE /identities/:id
The identity
object represents the identity of an individual (or company) in the database.
{"id": "971c3241-9876-471e-b0b3-40040893efd0","identityOwner": null,"identityType": "person","verificationStatus": "pending","blocked": false,"status": "waiting","companyOfficer": false,"name": "Jonh Doe","email": "johndoe2@mailinator.com","address": {"city": "Tampa","state": "AL","street": "Ochard Street","country": "US","postalCode": "12345"},"phone": {"sms": true,"number": "345675643"},"tax": {"state": "FL","country": "US","idNumber": "134567890"},"birthday": "1991-12-01T00:00:00.000Z","gender": "Male","createdAt": "2021-02-17T11:53:13.199Z","updatedAt": "2021-02-17T11:53:13.199Z","deletedAt": null}
identity
. {"id": "5e0e5129-6e39-46c3-b5c3-e9465ac49034","identityOwner": null,"identityType": "person","verificationStatus": "pending","blocked": false,"status": "disabled","companyOfficer": false,"name": "John Doe","email": "bruno@mailinator.org","address": {"city": "Tampa","street": "Ochard Street","country": "PT","postalCode": "12345"},"phone": {"sms": true,"number": "345675643"},"tax": {"state": "FL","country": "PT","idNumber": "134567890"},"birthday": "1991-12-01T00:00:00.000Z","gender": "Male","createdAt": "2020-02-19T11:02:14.456Z","updatedAt": "2020-02-19T11:02:14.456Z","deletedAt": null}
​
POST [ENVIRONMENT HOSTNAME]/identities​{"name": "Jonh Doe","email": "johndoe2@mailinator.com","companyOfficer": false,"birthday": "1991-12-01","gender": "Male","identityType": "person","address": {"street": "Ochard Street","postalCode": "12345","city": "Tampa","country": "US","state": "AL"},"phone": {"number": "345675643","sms": true},"tax": {"idNumber": "134567890","state": "FL","country": "US"}}
curl --location --request POST 'https://api.tst.publicmint.io/identities' \--header 'Content-Type: application/json' \--header 'apiKey: J8fMImECtv0jAYXJ8D6gS48z45B3YeC5' \--data-raw '{"name": "Jonh Doe","email": "johndoe2@mailinator.com","companyOfficer": false,"birthday": "1991-12-01","gender": "Male","identityType": "person","address": {"street": "Ochard Street","postalCode": "12345","city": "Tampa","country": "US","state": "AL"},"phone": {"number": "345675643","sms": true},"tax": {"idNumber": "134567890","state": "FL","country": "US"}}'
{"id": "971c3241-9876-471e-b0b3-40040893efd0","identityOwner": null,"identityType": "person","verificationStatus": "pending","blocked": false,"status": "waiting","companyOfficer": false,"name": "Jonh Doe","email": "johndoe2@mailinator.com","address": {"city": "Tampa","state": "AL","street": "Ochard Street","country": "US","postalCode": "12345"},"phone": {"sms": true,"number": "345675643"},"tax": {"state": "FL","country": "US","idNumber": "134567890"},"birthday": "1991-12-01T00:00:00.000Z","gender": "Male","createdAt": "2021-02-17T11:53:13.199Z","updatedAt": "2021-02-17T11:53:13.199Z","deletedAt": null}
On the Sandbox environment, you can use the approve KYC endpoint to simulate and approve or reject the identity you created.
identity
owned by you from the database.{"id": "971c3241-9876-471e-b0b3-40040893efd0","identityOwner": null,"identityType": "person","verificationStatus": "pending","blocked": false,"status": "active","companyOfficer": false,"name": "Jonh Doe","email": "johndoe2@mailinator.com","address": {"city": "Tampa","state": "AL","street": "Ochard Street","country": "US","postalCode": "12345"},"phone": {"sms": true,"number": "345675643"},"tax": {"state": "FL","country": "US","idNumber": "134567890"},"birthday": "1991-12-01T00:00:00.000Z","gender": "Male","createdAt": "2021-02-17T11:53:13.199Z","updatedAt": "2021-02-17T11:53:14.484Z","deletedAt": null}
GET [ENVIRONMENT HOSTNAME]/identities/971c3241-9876-471e-b0b3-40040893efd0
curl -X GET \[ENVIRONMENT HOSTNAME]/identities/e65dde2c-4379-42c7-a665-3f476cebb691 \-H 'apikey: {INSERT YOUR API KEY HERE}' \
{"id": "e65dde2c-4379-42c7-a665-3f476cebb691","identityOwner": null,"identityType": "person","verificationStatus": "pending","blocked": false,"status": "active","companyOfficer": false,"name": "Jonh Doe","email": "johndoe@gmsail.org","address": {"city": "Tampa","state": "AL","street": "Ochard Street","country": "US","postalCode": "12345"},"phone": {"sms": true,"number": "345675643"},"tax": {"state": "FL","country": "US","idNumber": "134567890"},"birthday": "1991-12-01T00:00:00.000Z","gender": "Male","createdAt": "2020-02-19T11:04:59.345Z","updatedAt": "2020-02-19T11:05:00.644Z","deletedAt": null}
identities
owned by you.{"total": 1,"data": [{"id": "971c3241-9876-471e-b0b3-40040893efd0","identityOwner": null,"identityType": "person","verificationStatus": "pending","blocked": false,"status": "active","companyOfficer": false,"name": "Jonh Doe","email": "johndoe2@mailinator.com","address": {"city": "Tampa","state": "AL","street": "Ochard Street","country": "US","postalCode": "12345"},"phone": {"sms": true,"number": "345675643"},"tax": {"state": "FL","country": "US","idNumber": "134567890"},"birthday": "1991-12-01T00:00:00.000Z","gender": "Male","createdAt": "2021-02-17T11:53:13.199Z","updatedAt": "2021-02-17T11:53:14.484Z","deletedAt": null}]}
​
GET [ENVIRONMENT HOSTNAME]/identities​// PAGINATED​GET [ENVIRONMENT HOSTNAME]/identities?page[number]=1&page[size]=1
curl -X GET \[ENVIRONMENT HOSTNAME]/identities \-H 'apikey: {INSERT YOUR API KEY HERE}'
{"total": 1,"data": [{"id": "971c3241-9876-471e-b0b3-40040893efd0","identityOwner": null,"identityType": "person","verificationStatus": "pending","blocked": false,"status": "active","companyOfficer": false,"name": "Jonh Doe","email": "johndoe2@mailinator.com","address": {"city": "Tampa","state": "AL","street": "Ochard Street","country": "US","postalCode": "12345"},"phone": {"sms": true,"number": "345675643"},"tax": {"state": "FL","country": "US","idNumber": "134567890"},"birthday": "1991-12-01T00:00:00.000Z","gender": "Male","createdAt": "2021-02-17T11:53:13.199Z","updatedAt": "2021-02-17T11:53:14.484Z","deletedAt": null}]}
{"total": 1,"data": [{"id": "730de6f9-c77d-40a4-82d4-193394e1e571","identityId": "971c3241-9876-471e-b0b3-40040893efd0","amount": "12","currency": "USD","blockchainAddress": "0x359f194ce353b1415abff5fcb07baf59f0bda0de","transferMethodInformation": {"transferType": "wire"},"status": "waiting","reference": null,"createdAt": "2021-02-17T12:03:11.871Z","updatedAt": "2021-02-17T12:03:11.871Z"}]}
​
GET [ENVIRONMENT HOSTNAME]/identities/971c3241-9876-471e-b0b3-40040893efd0/deposits
curl -X GET \[ENVIRONMENT HOSTNAME]/identities/971c3241-9876-471e-b0b3-40040893efd0/deposits \-H 'apikey: {INSERT API KEY HERE}'
{"total": 1,"data": [{"id": "730de6f9-c77d-40a4-82d4-193394e1e571","identityId": "971c3241-9876-471e-b0b3-40040893efd0","amount": "12","currency": "USD","blockchainAddress": "0x359f194ce353b1415abff5fcb07baf59f0bda0de","transferMethodInformation": {"transferType": "wire"},"status": "waiting","reference": null,"createdAt": "2021-02-17T12:03:11.871Z","updatedAt": "2021-02-17T12:03:11.871Z"}]}
{"total": 1,"data": [{"id": "2642dedd-4fa0-40bf-8b15-7c0513bcdb38","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","transferType": "ach","transactionReference": "0xbba8f98772463079ed98826507b5accc0180220ef45641e6d882d43260a082f7","blockchainAddress": "0x8ba13aB181E9F30e543C6376Cd408192E95bCD1C","amount": null,"currency": "USD","transactionHash": null,"transferMethodId": "ce953d97-4e41-4396-8626-12d07914c045","status": "prepared","createdAt": "2020-02-19T11:43:04.553Z","updatedAt": "2020-02-19T11:43:04.553Z"}]}​​​
GET [ENVIRONMENT HOSTNAME]/identities/7c8867d7-b9b8-40de-86c7-f4a8e4ee566d/withdrawals​// PAGINAT£D​GET [ENVIRONMENT HOSTNAME]/identities/7c8867d7-b9b8-40de-86c7-f4a8e4ee566d/withdrawals?page[number]=1&page[size]=1
curl -X GET \[ENVIRONMENT HOSTNAME]/identities/5b145407-ebca-474c-92be-a0a5c577f1aa/withdrawals \-H 'apikey: {INSERT API KEY HERE}'
{"total": 1,"data": [{"id": "2642dedd-4fa0-40bf-8b15-7c0513bcdb38","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","transferType": "ach","transactionReference": "0xbba8f98772463079ed98826507b5accc0180220ef45641e6d882d43260a082f7","blockchainAddress": "0x8ba13aB181E9F30e543C6376Cd408192E95bCD1C","amount": null,"currency": "USD","transactionHash": null,"transferMethodId": "ce953d97-4e41-4396-8626-12d07914c045","status": "prepared","createdAt": "2020-02-19T11:43:04.553Z","updatedAt": "2020-02-19T11:43:04.553Z"}]}​​​
{"total": 1,"data": [{"id": "6215e0aa-dde7-40ac-af3b-b6fa733529ff","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","status": "active","label": "identity card","description": "identity card of jonh smith","extension": ".jpg","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e6/5d/de/2c/tLHGdo6z3PgOp4lR.jpeg","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2020-02-19T15:15:23.546Z","updatedAt": "2020-02-19T15:15:24.864Z","deletedAt": null}]}
​
GET [ENVIRONMENT HOSTNAME]/identities/32634b13-c370-4e77-afbc-2841d9d4b760/documents// PAGINATEDGET [ENVIRONMENT HOSTNAME]/identities/32634b13-c370-4e77-afbc-2841d9d4b760/documents?page[number]=1&page[size]=1
curl -X GET \[ENVIRONMENT HOSTNAME]/identities/5f5e13fb-c5d7-488b-923b-278b96b138b9/documents \-H "apikey: {INSERT YOUR API KEY HERE}" \
{"total": 1,"data": [{"id": "6215e0aa-dde7-40ac-af3b-b6fa733529ff","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","status": "active","label": "identity card","description": "identity card of jonh smith","extension": ".jpg","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e6/5d/de/2c/tLHGdo6z3PgOp4lR.jpeg","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2020-02-19T15:15:23.546Z","updatedAt": "2020-02-19T15:15:24.864Z","deletedAt": null}]}
​
​
GET [ENVIRONMENT HOSTNAME]/identities/74418597-9bc9-4791-aadc-8993961509c9/verifications​// PAGINATED​GET [ENVIRONMENT HOSTNAME]/identities/74418597-9bc9-4791-aadc-8993961509c9/verifications?page[number]=1&page[size]=1
curl -X GET \[ENVIRONMENT HOSTNAME]/identities/5b145407-ebca-474c-92be-a0a5c577f1aa/verifications \-H 'apikey: {INSERT API KEY HERE}'
{"total": 4,"data": [{"id": "c0f38c55-3d93-4799-b3e9-da7ba195ab1e","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","status": "approved","exceptionDetails": "","createdAt": "2020-02-19T11:05:07.750Z","updatedAt": "2020-02-19T11:42:57.138Z"},{"id": "7116651f-bf20-4a73-9f0a-b61d3e72568f","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","status": "approved","exceptionDetails": "","createdAt": "2020-02-19T11:05:07.760Z","updatedAt": "2020-02-19T11:42:57.248Z"},{"id": "20c1fdd8-675f-4c88-b7ef-740db119c3d4","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","status": "approved","exceptionDetails": "","createdAt": "2020-02-19T11:05:07.853Z","updatedAt": "2020-02-19T11:42:57.462Z"},{"id": "9ad2b23a-c2f0-4f80-af5c-0deb7a0a57e6","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","status": "approved","exceptionDetails": "","createdAt": "2020-02-19T11:05:07.955Z","updatedAt": "2020-02-19T11:42:57.644Z"}]}
{"total": 1,"data": [{"id": "138b20f1-b99c-4abc-894a-e587a53fdfb9","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","transferMethodInformation": {"transferType": "ach","routingNumber": "123456789","bankAccountName": "Bruno Ramos","bankAccountNumber": "123123123"},"createdAt": "2020-01-09T12:10:49.572Z","updatedAt": "2020-01-09T12:10:50.168Z","deletedAt": null}]}
​
GET [ENVIRONMENT HOSTNAME]/identities/e0564926-96e0-42e2-a544-68bc18598e40/transfer-methods​// PAGINATED​GET [ENVIRONMENT HOSTNAME]/identities/e0564926-96e0-42e2-a544-68bc18598e40/transfer-methods?page[number]=1&page[size]=1
curl --location --request GET 'https://api.tst.publicmint.io/identities/e0564926-96e0-42e2-a544-68bc18598e40/transfer-methods' \--header 'apikey: {INSERT YOUR API KEY HERE}'
{"total": 1,"data": [{"id": "b28d7969-ff31-435a-a173-469d6136da4c","appId": "f3f8f171-975a-436d-9c7f-92f2fb145385","fromIdentity": "577b2ebc-4d08-42fc-9217-46eae3bb2426","toIdentity": "f51c7041-fdab-4f03-acaf-9c34df178724","label": "CEO"}]​​
​
Example call
GET [ENVIRONMENT HOSTNAME]/identities/577b2ebc-4d08-42fc-9217-46eae3bb2426/identity-relations
curl -X GET \[ENVIRONMENT HOSTNAME]/identities/577b2ebc-4d08-42fc-9217-46eae3bb2426/identity-relations \-H 'Content-Type: application/json' \-H 'apikey: {INSERT YOUR API KEY HERE}'
{"total": 1,"data": [{"id": "b28d7969-ff31-435a-a173-469d6136da4c","appId": "f3f8f171-975a-436d-9c7f-92f2fb145385","fromIdentity": "577b2ebc-4d08-42fc-9217-46eae3bb2426","toIdentity": "f51c7041-fdab-4f03-acaf-9c34df178724","label": "CEO"}]​
{"id": "6215e0aa-dde7-40ac-af3b-b6fa733529ff","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","status": "active","label": "identity card","description": "identity card of jonh smith","extension": ".jpg","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e6/5d/de/2c/tLHGdo6z3PgOp4lR.jpeg","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2020-02-19T15:15:23.546Z","updatedAt": "2020-02-19T15:15:24.864Z","deletedAt": null}
​
Example call
POST [ENVIRONMENT HOSTNAME]/identities/577b2ebc-4d08-42fc-9217-46eae3bb2426/kyc-document-check
curl --location --request POST 'https://api.tst.publicmint.io/identities/e0564926-96e0-42e2-a544-68bc18598e40/kyc-document-check' \--header 'Content-Type: application/json' \--header 'apikey: {INSERT YOUR API KEY HERE}'
{"id": "6215e0aa-dde7-40ac-af3b-b6fa733529ff","identityId": "e65dde2c-4379-42c7-a665-3f476cebb691","status": "active","label": "identity card","description": "identity card of jonh smith","extension": ".jpg","fileUrl": "https://pmint-custodial-api-tst-identity-docs.s3.amazonaws.com/e6/5d/de/2c/tLHGdo6z3PgOp4lR.jpeg","documentType": "IdentityCard","documentSide": "FrontSide","createdAt": "2020-02-19T15:15:23.546Z","updatedAt": "2020-02-19T15:15:24.864Z","deletedAt": null}
​
​