The identity object represents the identity of an individual (or company) in the database.
Identity entity model
Name
Type
Description
Constraints
Address information
Phone information
Tax information
Create an identity
POST /identities
POST[ENVIRONMENT HOSTNAME]/identities
This endpoint allows you to create a new identity.
Request Parameters
None
Body parameters
Body address parameters
Body documents parameters
Body phone parameters
Body tax parameters
Response Options
400 Bad Request
validation_failed
If the required parameters are not provided.
If additional parameters are provided.
If some of the parameters type is invalid.
If some of the parameters constraints is not respected.
email_already_in_use
404 Not Found
identity_owner_not_found
If a non existent identity owner id is provided.
422 Unprocessable entity
identity_owner_must_be_of_type_person
If identity owner is not of type person.
200 OK
Example Call
POST [ENVIRONMENTHOSTNAME]/identities{"address": {"city":"Braga","country":"PT","postalCode":"4444-333","state":"Braga","street":"Avenida D. João I, 40" },"birthday": "2000-11-11","email": "foobar@publicmint.com","gender": "Male","name": "João Pedro Soares","phone": {"number":"910000000","sms":false },"tax": {"country":"PT","idNumber":"1111111111","state":"Braga" },"type": "person","documents": [{"description":"ID card","label":"id card","side":"FrontSide","type":"IdentityCard","url":"https://[pmint_aws_s3_bucket].s3.amazonaws.com/fd/fc/09/dd/4nHVF9Hz9FArIrUo.jpeg" }],"faceImages": ["https://[pmint_aws_s3_bucket].s3.amazonaws.com/fd/fc/09/dd/4nHVF9Hz9FArIrUo.jpeg"]}
{"data": {"documents": [ {"createdAt":"2022-03-31T13:08:52.049Z","deletedAt":null,"description":"ID card","id":"bfca84a4-3e52-4a7d-92da-b17c6a5e59ac","identityId":"38882f21-ce8f-4e18-8b83-e43e082912ef","label":"id card","side":"frontSide","type":"identityCard","updatedAt":"2022-03-31T13:08:52.049Z", "url": "https://pmint-custodial-api-sandbox-identity-docs.s3.amazonaws.com/fd/fc/09/dd/4nHVF9Hz9FArIrUo.jpeg"
}, {"createdAt":"2022-03-31T13:08:52.114Z","deletedAt":null,"description":null,"id":"0b12e957-5643-4943-9eeb-6755c02721e0","identityId":"38882f21-ce8f-4e18-8b83-e43e082912ef","label":null,"side":"frontSide","type":"faceImage","updatedAt":"2022-03-31T13:08:52.114Z", "url": "https://pmint-custodial-api-sandbox-identity-docs.s3.amazonaws.com/fd/fc/09/dd/4nHVF9Hz9FArIrUo.jpeg"
} ],"address": {"city":"Braga","state":"Braga","street":"Avenida D. João I, 40","country":"PT","postalCode":"4444-333" },"appId":"80937bc6-9578-45c8-b691-ea6b8a5d17e9","birthday":"2000-11-11","blocked":false,"createdAt":"2022-03-31T13:08:52.030Z","email":"foobar@publicmint.com","gender":"Male","id":"38882f21-ce8f-4e18-8b83-e43e082912ef","identityConfirmed":false,"identityOwner":null,"name":"João Pedro Soares","phone": {"sms":false,"number":"910000000" },"tax": {"state":"Braga","country":"PT","idNumber":"1111111111" },"type":"person","updatedAt":"2022-03-31T13:08:52.030Z" }}
On the Sandbox environment, you can use the approve KYC endpoint to simulate and approve or reject the identity you created.
Get an identity
GET /identities/:id
GET[ENVIRONMENT HOSTNAME]/identities/:id
This endpoint retrieves and returns an identity owned by you from the database.
Request Parameters
Path parameters
Example Call
GET [ENVIRONMENTHOSTNAME]/identities/38882f21-ce8f-4e18-8b83-e43e082912ef
curl --location --request GET 'https://api.sandbox.publicmint.io/identities/38882f21-ce8f-4e18-8b83-e43e082912ef' \
--header 'apiKey: dfQ0ouwt0R14TPd2wxBzKtslWrBN5zfm'
{"data": {"address": {"city":"Braga","state":"Braga","street":"Avenida D. João I, 40","country":"PT","postalCode":"4444-333" },"appId":"80937bc6-9578-45c8-b691-ea6b8a5d17e9","birthday":"2000-11-11","blocked":false,"createdAt":"2022-03-31T13:08:52.030Z","email":"foobar@publicmint.com","gender":"Male","id":"38882f21-ce8f-4e18-8b83-e43e082912ef","identityConfirmed":false,"identityOwner":null,"name":"João Pedro Soares","phone": {"sms":false,"number":"910000000" },"tax": {"state":"Braga","country":"PT","idNumber":"1111111111" },"type":"person","updatedAt":"2022-03-31T13:08:52.030Z" }}
Get identities
GET /identities
GET[ENVIRONMENT HOSTNAME]/identities
This endpoint returns a paginated list of all identities owned by you.
Available filters
Available sorts
Paginate options
Response Options
200 OK
Example Call
GET [ENVIRONMENTHOSTNAME]/identities// PAGINATEDGET [ENVIRONMENTHOSTNAME]/identities?page[number]=1&page[size]=1
{"data": [ {"address": {"city":"Braga","state":"Braga","street":"Avenida D. João I, 40","country":"PT","postalCode":"4444-333" },"appId":"80937bc6-9578-45c8-b691-ea6b8a5d17e9","birthday":"2000-11-11","blocked":false,"createdAt":"2022-03-31T13:08:52.030Z","email":"foobar@publicmint.com","gender":"Male","id":"38882f21-ce8f-4e18-8b83-e43e082912ef","identityConfirmed":false,"identityOwner":null,"name":"João Pedro Soares","phone": {"sms":false,"number":"910000000" },"tax": {"state":"Braga","country":"PT","idNumber":"1111111111" },"type":"person","updatedAt":"2022-03-31T13:08:52.030Z" } ],"total": 1}
Get identity document presign url
Returns a presign url to view a specific identity document.
GET /identities/:identityId/documents/:id/presign-url
