Purpose:
This HTTP POST request is used to create a new digital license for a specific project within an organization. It requires the organization ID and project ID in the URL path.
Request URL Structure:
\nPOST {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials\n\n{{api-host}}: The base URL of the API.
{{organization-id}}: The unique identifier of the organization.
{{project-id}}: The unique identifier of the project.
Parameters:
\ntemplateId: The unique identifier of the template used in for the digital license project.
additionalData: Additional data for the digital license, including mdlData and devicePublicKey.
mdlData: Data for the digital license, including personal information and document details.
family_name: The family name of the individual.
given_name: The given name of the individual.
birth_date: The birth date of the individual.
issue_date: The issue date of the document.
expiry_date: The expiry date of the document.
issuing_country: The issuing country of the document.
issuing_authority: The issuing authority of the document.
document_number: The document number.
portrait: The portrait of the individual.
driving_privileges: Details of driving privileges including vehicle category code, issue date, expiry date, and codes.
un_distinguishing_sign: Un-distinguishing sign for the issuing country.
devicePublicKey: Public key information for the device in JWK format
Request Body (Raw):
\n{\n \"receiver\": \"86a4da0593fd03d70f36d9d2914a44 ...\",\n \"templateId\": \"55555555-2222-cccc-bbbb-2e2e2e ...\",\n \"additionalData\": {\n \"mdlData\": {\n \"family_name\": \"Maravi\",\n \"given_name\": \"Carlos\",\n \"birth_date\": \"1987-03-15\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"issuing_country\": \"US\",\n \"issuing_authority\": \"Sertracen\",\n \"document_number\": \"8-203-1365\",\n \"portrait\": \"FFD8FFE000104A4649460001010100 ...\",\n \"driving_privileges\": [\n {\n \"vehicle_category_code\": \"A\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"codes\": [\n {\n \"code\": \"A1\",\n \"sign\": \"+\",\n \"value\": \"automatic\"\n }\n ]\n }\n ],\n \"un_distinguishing_sign\": \"PA\"\n },\n \"devicePublicKey\": {\n \"kty\": \"EC\",\n \"x\": \"iBh5ynojixm_D0wfjADpouGbp6b3Pq ...\",\n \"y\": \"oxS1OAORJ7XNUHNfVFGeM8E0RQVFxW ...\",\n \"crv\": \"P-256\"\n }\n }\n}\n\nExpected Response Format:
\n{\n \"credential\": {\n \"_id\": \"\",\n \"issuer\": \"\",\n \"receiver\": null,\n \"data\": {\n \"DocType\": \"\",\n \"issuerNameSpaces\": {\n \"org_iso_18013_5_1\": [\n {\n \"dataItem\": {\n \"data\": {\n \"digestID\": 0,\n \"random\": \"\",\n \"elementIdentifier\": \"\",\n \"elementValue\": \"\"\n }\n },\n \"isValid\": true\n }\n ]\n },\n \"deviceKeyInfo\": {\n \"DeviceKey\": {\n \"1\": 0,\n \"3\": 0,\n \"-1\": 0,\n \"-2\": \"\",\n \"-3\": \"\"\n }\n },\n \"validityInfo\": {\n \"Signed\": \"\",\n \"ValidFrom\": \"\",\n \"ValidUntil\": \"\",\n \"ExpectedUpdate\": \"\"\n },\n \"digestAlgorithm\": \"\",\n \"payload\": \"\"\n },\n \"issued\": null,\n \"template\": {\n \"id\": \"\",\n \"name\": null,\n \"description\": null,\n \"projectId\": \"\",\n \"organizationId\": \"\"\n },\n \"pdf\": null,\n \"thumbnail\": null,\n \"status\": \"\",\n \"signers\": null,\n \"approvers\": null,\n \"signatures\": null,\n \"creation\": {\n \"userId\": \"\",\n \"createdAt\": \"\"\n },\n \"revocation\": null,\n \"issuance\": null,\n \"signaturesCompletedAt\": null,\n \"evidence\": null,\n \"code\": null\n },\n \"signingMessage\": \"\"\n}\n\nPurpose:
This HTTP POST request is used to create a new digital license for a specific project within an organization. It requires the organization ID and project ID in the URL path.
Request URL Structure:
\nPOST {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials\n\n{{api-host}}: The base URL of the API.
{{organization-id}}: The unique identifier of the organization.
{{project-id}}: The unique identifier of the project.
Parameters:
\ntemplateId: The unique identifier of the template used in for the digital license project.
additionalData: Additional data for the digital license, including mdlData and devicePublicKey.
mdlData: Data for the digital license, including personal information and document details.
family_name: The family name of the individual.
given_name: The given name of the individual.
birth_date: The birth date of the individual.
issue_date: The issue date of the document.
expiry_date: The expiry date of the document.
issuing_country: The issuing country of the document.
issuing_authority: The issuing authority of the document.
document_number: The document number.
portrait: The portrait of the individual.
driving_privileges: Details of driving privileges including vehicle category code, issue date, expiry date, and codes.
un_distinguishing_sign: Un-distinguishing sign for the issuing country.
devicePublicKey: Public key information for the device in JWK format
Request Body (Raw):
\n{\n \"receiver\": \"86a4da0593fd03d70f36d9d2914a44 ...\",\n \"templateId\": \"55555555-2222-cccc-bbbb-2e2e2e ...\",\n \"additionalData\": {\n \"mdlData\": {\n \"family_name\": \"Maravi\",\n \"given_name\": \"Carlos\",\n \"birth_date\": \"1987-03-15\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"issuing_country\": \"US\",\n \"issuing_authority\": \"Sertracen\",\n \"document_number\": \"8-203-1365\",\n \"portrait\": \"FFD8FFE000104A4649460001010100 ...\",\n \"driving_privileges\": [\n {\n \"vehicle_category_code\": \"A\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"codes\": [\n {\n \"code\": \"A1\",\n \"sign\": \"+\",\n \"value\": \"automatic\"\n }\n ]\n }\n ],\n \"un_distinguishing_sign\": \"PA\"\n },\n \"devicePublicKey\": {\n \"kty\": \"EC\",\n \"x\": \"iBh5ynojixm_D0wfjADpouGbp6b3Pq ...\",\n \"y\": \"oxS1OAORJ7XNUHNfVFGeM8E0RQVFxW ...\",\n \"crv\": \"P-256\"\n }\n }\n}\n\nExpected Response Format:
\n{\n \"credential\": {\n \"_id\": \"\",\n \"issuer\": \"\",\n \"receiver\": null,\n \"data\": {\n \"DocType\": \"\",\n \"issuerNameSpaces\": {\n \"org_iso_18013_5_1\": [\n {\n \"dataItem\": {\n \"data\": {\n \"digestID\": 0,\n \"random\": \"\",\n \"elementIdentifier\": \"\",\n \"elementValue\": \"\"\n }\n },\n \"isValid\": true\n }\n ]\n },\n \"deviceKeyInfo\": {\n \"DeviceKey\": {\n \"1\": 0,\n \"3\": 0,\n \"-1\": 0,\n \"-2\": \"\",\n \"-3\": \"\"\n }\n },\n \"validityInfo\": {\n \"Signed\": \"\",\n \"ValidFrom\": \"\",\n \"ValidUntil\": \"\",\n \"ExpectedUpdate\": \"\"\n },\n \"digestAlgorithm\": \"\",\n \"payload\": \"\"\n },\n \"issued\": null,\n \"template\": {\n \"id\": \"\",\n \"name\": null,\n \"description\": null,\n \"projectId\": \"\",\n \"organizationId\": \"\"\n },\n \"pdf\": null,\n \"thumbnail\": null,\n \"status\": \"\",\n \"signers\": null,\n \"approvers\": null,\n \"signatures\": null,\n \"creation\": {\n \"userId\": \"\",\n \"createdAt\": \"\"\n },\n \"revocation\": null,\n \"issuance\": null,\n \"signaturesCompletedAt\": null,\n \"evidence\": null,\n \"code\": null\n },\n \"signingMessage\": \"\"\n}\n\nThis API endpoint is a HTTP PUT request used to assemble a digital license providing signature and certificate for a specific credential within a project of an organization.
\nMethod: PUT
\nPath: {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials/{{_credential_id}}/sign
Body:
\ntemplateId (string): The ID of the template.
signature (string): The signature for the credential.
kid (string): The key ID of the jwk
certificate (string): The PEM certificate.
{ \"type\": \"string\" }
\nDescription: The response is final mDL compliant with ISO18013-5 in hex format
\nThis API endpoint is a HTTP PUT request used to assemble a digital license providing signature and certificate for a specific credential within a project of an organization.
\nMethod: PUT
\nPath: {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials/{{_credential_id}}/sign
Body:
\ntemplateId (string): The ID of the template.
signature (string): The signature for the credential.
kid (string): The key ID of the jwk
certificate (string): The PEM certificate.
{ \"type\": \"string\" }
\nDescription: The response is final mDL compliant with ISO18013-5 in hex format
\nThis API endpoint is a HTTP PUT request used to assemble a digital license providing signature and certificate for a specific credential within a project of an organization.
\nMethod: PUT
\nPath: {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials/{{_credential_id}}/sign
Body:
\ntemplateId (string): The ID of the template.
signature (string): The signature for the credential.
kid (string): The key ID of the jwk
certificate (string): The PEM certificate.
{ \"type\": \"string\" }
\nDescription: The response is final mDL compliant with ISO18013-5 in hex format
\nthis module is in charge of generate and sign ISO-18031 digital licenses
\n","_postman_id":"d293076e-f842-4671-9ded-1fc31bc88aab"},{"name":"w3c","item":[{"name":"create","event":[{"listen":"test","script":{"id":"18851f45-c84a-41af-8251-f417fe357aad","exec":["pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);",""," const responseJson = pm.response.json();"," pm.environment.set(\"_signingMessage\", responseJson.signingMessage);"," pm.environment.set(\"_credential_id\", responseJson.credential._id);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0e31690f-97a4-4fdf-9c32-0f52bfa14231","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"projectId\":\"9697f34c-6ba5-4f79-b6dc-0434379d9646\",\n \"templateId\":\"6cba8cf5-2d00-4baa-b18a-8797c8c8b550\",\n \"additionalData\":{\n \"w3cData\":{\n \"email\":\"carlos@email.com\",\n \"name\":\"Carlos\",\n \"lastname\":\"Maravi\"\n }\n },\n \"organizationUser\":{\n \"email\":\"carlitos@email.com\",\n \"did\":\"did:lac1:1iT4pJXCP5YJhPWkXxgNRrGDA8SM4ckNqTTkHPx3NfQRyVGuFfhs5y5kcQmRiDL6rB67\"\n },\n \"options\":{\n \"approvers\":false\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials","description":"Purpose:
This HTTP POST request is used to create a new digital license for a specific project within an organization. It requires the organization ID and project ID in the URL path.
Request URL Structure:
\nPOST {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials\n\n{{api-host}}: The base URL of the API.
{{organization-id}}: The unique identifier of the organization.
{{project-id}}: The unique identifier of the project.
Parameters:
\ntemplateId: The unique identifier of the template used in for the digital license project.
additionalData: Additional data for the digital license, including mdlData and devicePublicKey.
mdlData: Data for the digital license, including personal information and document details.
family_name: The family name of the individual.
given_name: The given name of the individual.
birth_date: The birth date of the individual.
issue_date: The issue date of the document.
expiry_date: The expiry date of the document.
issuing_country: The issuing country of the document.
issuing_authority: The issuing authority of the document.
document_number: The document number.
portrait: The portrait of the individual.
driving_privileges: Details of driving privileges including vehicle category code, issue date, expiry date, and codes.
un_distinguishing_sign: Un-distinguishing sign for the issuing country.
devicePublicKey: Public key information for the device in JWK format
Request Body (Raw):
\n{\n \"receiver\": \"86a4da0593fd03d70f36d9d2914a44 ...\",\n \"templateId\": \"55555555-2222-cccc-bbbb-2e2e2e ...\",\n \"additionalData\": {\n \"mdlData\": {\n \"family_name\": \"Maravi\",\n \"given_name\": \"Carlos\",\n \"birth_date\": \"1987-03-15\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"issuing_country\": \"US\",\n \"issuing_authority\": \"Sertracen\",\n \"document_number\": \"8-203-1365\",\n \"portrait\": \"FFD8FFE000104A4649460001010100 ...\",\n \"driving_privileges\": [\n {\n \"vehicle_category_code\": \"A\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"codes\": [\n {\n \"code\": \"A1\",\n \"sign\": \"+\",\n \"value\": \"automatic\"\n }\n ]\n }\n ],\n \"un_distinguishing_sign\": \"PA\"\n },\n \"devicePublicKey\": {\n \"kty\": \"EC\",\n \"x\": \"iBh5ynojixm_D0wfjADpouGbp6b3Pq ...\",\n \"y\": \"oxS1OAORJ7XNUHNfVFGeM8E0RQVFxW ...\",\n \"crv\": \"P-256\"\n }\n }\n}\n\nExpected Response Format:
\n{\n \"credential\": {\n \"_id\": \"\",\n \"issuer\": \"\",\n \"receiver\": null,\n \"data\": {\n \"DocType\": \"\",\n \"issuerNameSpaces\": {\n \"org_iso_18013_5_1\": [\n {\n \"dataItem\": {\n \"data\": {\n \"digestID\": 0,\n \"random\": \"\",\n \"elementIdentifier\": \"\",\n \"elementValue\": \"\"\n }\n },\n \"isValid\": true\n }\n ]\n },\n \"deviceKeyInfo\": {\n \"DeviceKey\": {\n \"1\": 0,\n \"3\": 0,\n \"-1\": 0,\n \"-2\": \"\",\n \"-3\": \"\"\n }\n },\n \"validityInfo\": {\n \"Signed\": \"\",\n \"ValidFrom\": \"\",\n \"ValidUntil\": \"\",\n \"ExpectedUpdate\": \"\"\n },\n \"digestAlgorithm\": \"\",\n \"payload\": \"\"\n },\n \"issued\": null,\n \"template\": {\n \"id\": \"\",\n \"name\": null,\n \"description\": null,\n \"projectId\": \"\",\n \"organizationId\": \"\"\n },\n \"pdf\": null,\n \"thumbnail\": null,\n \"status\": \"\",\n \"signers\": null,\n \"approvers\": null,\n \"signatures\": null,\n \"creation\": {\n \"userId\": \"\",\n \"createdAt\": \"\"\n },\n \"revocation\": null,\n \"issuance\": null,\n \"signaturesCompletedAt\": null,\n \"evidence\": null,\n \"code\": null\n },\n \"signingMessage\": \"\"\n}\n\nPurpose:
This HTTP POST request is used to create a new digital license for a specific project within an organization. It requires the organization ID and project ID in the URL path.
Request URL Structure:
\nPOST {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials\n\n{{api-host}}: The base URL of the API.
{{organization-id}}: The unique identifier of the organization.
{{project-id}}: The unique identifier of the project.
Parameters:
\ntemplateId: The unique identifier of the template used in for the digital license project.
additionalData: Additional data for the digital license, including mdlData and devicePublicKey.
mdlData: Data for the digital license, including personal information and document details.
family_name: The family name of the individual.
given_name: The given name of the individual.
birth_date: The birth date of the individual.
issue_date: The issue date of the document.
expiry_date: The expiry date of the document.
issuing_country: The issuing country of the document.
issuing_authority: The issuing authority of the document.
document_number: The document number.
portrait: The portrait of the individual.
driving_privileges: Details of driving privileges including vehicle category code, issue date, expiry date, and codes.
un_distinguishing_sign: Un-distinguishing sign for the issuing country.
devicePublicKey: Public key information for the device in JWK format
Request Body (Raw):
\n{\n \"receiver\": \"86a4da0593fd03d70f36d9d2914a44 ...\",\n \"templateId\": \"55555555-2222-cccc-bbbb-2e2e2e ...\",\n \"additionalData\": {\n \"mdlData\": {\n \"family_name\": \"Maravi\",\n \"given_name\": \"Carlos\",\n \"birth_date\": \"1987-03-15\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"issuing_country\": \"US\",\n \"issuing_authority\": \"Sertracen\",\n \"document_number\": \"8-203-1365\",\n \"portrait\": \"FFD8FFE000104A4649460001010100 ...\",\n \"driving_privileges\": [\n {\n \"vehicle_category_code\": \"A\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"codes\": [\n {\n \"code\": \"A1\",\n \"sign\": \"+\",\n \"value\": \"automatic\"\n }\n ]\n }\n ],\n \"un_distinguishing_sign\": \"PA\"\n },\n \"devicePublicKey\": {\n \"kty\": \"EC\",\n \"x\": \"iBh5ynojixm_D0wfjADpouGbp6b3Pq ...\",\n \"y\": \"oxS1OAORJ7XNUHNfVFGeM8E0RQVFxW ...\",\n \"crv\": \"P-256\"\n }\n }\n}\n\nExpected Response Format:
\n{\n \"credential\": {\n \"_id\": \"\",\n \"issuer\": \"\",\n \"receiver\": null,\n \"data\": {\n \"DocType\": \"\",\n \"issuerNameSpaces\": {\n \"org_iso_18013_5_1\": [\n {\n \"dataItem\": {\n \"data\": {\n \"digestID\": 0,\n \"random\": \"\",\n \"elementIdentifier\": \"\",\n \"elementValue\": \"\"\n }\n },\n \"isValid\": true\n }\n ]\n },\n \"deviceKeyInfo\": {\n \"DeviceKey\": {\n \"1\": 0,\n \"3\": 0,\n \"-1\": 0,\n \"-2\": \"\",\n \"-3\": \"\"\n }\n },\n \"validityInfo\": {\n \"Signed\": \"\",\n \"ValidFrom\": \"\",\n \"ValidUntil\": \"\",\n \"ExpectedUpdate\": \"\"\n },\n \"digestAlgorithm\": \"\",\n \"payload\": \"\"\n },\n \"issued\": null,\n \"template\": {\n \"id\": \"\",\n \"name\": null,\n \"description\": null,\n \"projectId\": \"\",\n \"organizationId\": \"\"\n },\n \"pdf\": null,\n \"thumbnail\": null,\n \"status\": \"\",\n \"signers\": null,\n \"approvers\": null,\n \"signatures\": null,\n \"creation\": {\n \"userId\": \"\",\n \"createdAt\": \"\"\n },\n \"revocation\": null,\n \"issuance\": null,\n \"signaturesCompletedAt\": null,\n \"evidence\": null,\n \"code\": null\n },\n \"signingMessage\": \"\"\n}\n\nPurpose:
This HTTP POST request is used to create a new digital license for a specific project within an organization. It requires the organization ID and project ID in the URL path.
Request URL Structure:
\nPOST {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials\n\n{{api-host}}: The base URL of the API.
{{organization-id}}: The unique identifier of the organization.
{{project-id}}: The unique identifier of the project.
Parameters:
\ntemplateId: The unique identifier of the template used in for the digital license project.
additionalData: Additional data for the digital license, including mdlData and devicePublicKey.
mdlData: Data for the digital license, including personal information and document details.
family_name: The family name of the individual.
given_name: The given name of the individual.
birth_date: The birth date of the individual.
issue_date: The issue date of the document.
expiry_date: The expiry date of the document.
issuing_country: The issuing country of the document.
issuing_authority: The issuing authority of the document.
document_number: The document number.
portrait: The portrait of the individual.
driving_privileges: Details of driving privileges including vehicle category code, issue date, expiry date, and codes.
un_distinguishing_sign: Un-distinguishing sign for the issuing country.
devicePublicKey: Public key information for the device in JWK format
Request Body (Raw):
\n{\n \"receiver\": \"86a4da0593fd03d70f36d9d2914a44 ...\",\n \"templateId\": \"55555555-2222-cccc-bbbb-2e2e2e ...\",\n \"additionalData\": {\n \"mdlData\": {\n \"family_name\": \"Maravi\",\n \"given_name\": \"Carlos\",\n \"birth_date\": \"1987-03-15\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"issuing_country\": \"US\",\n \"issuing_authority\": \"Sertracen\",\n \"document_number\": \"8-203-1365\",\n \"portrait\": \"FFD8FFE000104A4649460001010100 ...\",\n \"driving_privileges\": [\n {\n \"vehicle_category_code\": \"A\",\n \"issue_date\": \"2023-09-01\",\n \"expiry_date\": \"2028-09-30\",\n \"codes\": [\n {\n \"code\": \"A1\",\n \"sign\": \"+\",\n \"value\": \"automatic\"\n }\n ]\n }\n ],\n \"un_distinguishing_sign\": \"PA\"\n },\n \"devicePublicKey\": {\n \"kty\": \"EC\",\n \"x\": \"iBh5ynojixm_D0wfjADpouGbp6b3Pq ...\",\n \"y\": \"oxS1OAORJ7XNUHNfVFGeM8E0RQVFxW ...\",\n \"crv\": \"P-256\"\n }\n }\n}\n\nExpected Response Format:
\n{\n \"credential\": {\n \"_id\": \"\",\n \"issuer\": \"\",\n \"receiver\": null,\n \"data\": {\n \"DocType\": \"\",\n \"issuerNameSpaces\": {\n \"org_iso_18013_5_1\": [\n {\n \"dataItem\": {\n \"data\": {\n \"digestID\": 0,\n \"random\": \"\",\n \"elementIdentifier\": \"\",\n \"elementValue\": \"\"\n }\n },\n \"isValid\": true\n }\n ]\n },\n \"deviceKeyInfo\": {\n \"DeviceKey\": {\n \"1\": 0,\n \"3\": 0,\n \"-1\": 0,\n \"-2\": \"\",\n \"-3\": \"\"\n }\n },\n \"validityInfo\": {\n \"Signed\": \"\",\n \"ValidFrom\": \"\",\n \"ValidUntil\": \"\",\n \"ExpectedUpdate\": \"\"\n },\n \"digestAlgorithm\": \"\",\n \"payload\": \"\"\n },\n \"issued\": null,\n \"template\": {\n \"id\": \"\",\n \"name\": null,\n \"description\": null,\n \"projectId\": \"\",\n \"organizationId\": \"\"\n },\n \"pdf\": null,\n \"thumbnail\": null,\n \"status\": \"\",\n \"signers\": null,\n \"approvers\": null,\n \"signatures\": null,\n \"creation\": {\n \"userId\": \"\",\n \"createdAt\": \"\"\n },\n \"revocation\": null,\n \"issuance\": null,\n \"signaturesCompletedAt\": null,\n \"evidence\": null,\n \"code\": null\n },\n \"signingMessage\": \"\"\n}\n\nThis module is in charge of create, approve, sign and verify W3C and ISO-18031 credentials
\n","_postman_id":"654c3e84-fecf-4173-813c-fc6a2a3470b6"},{"name":"Notifications","item":[{"name":"Send Notifications","event":[{"listen":"test","script":{"id":"e7fddbeb-4d9c-4560-bd09-31d955adace8","exec":["pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);",""," const responseJson = pm.response.json();"," pm.environment.set(\"_item-id\", responseJson.items[0].id);","});",""],"type":"text/javascript","packages":{}}}],"id":"1c094cf2-8971-49ed-9af0-73b1431b4e68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"receiverData\": {\n \"id\": 123456,\n \"Amount\": \"200.5\"\n }\n },\n {\n \"receiverData\": {\n \"id\": \"2354fg\",\n \"Amount\": \"5238\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api-host}}/api/v1/organizations/{{organization-id}}/notifications/{{notification-group-id}}/items/bulk","description":"This endpoint allows you to send bulk notifications to a specified group within an organization. It is designed to handle multiple items in a single request, streamlining the notification process.
\nPOST {{api-host}}/api/v1/organizations/{{organization-id}}/notifications/{{notification-group-id}}/items/bulk
The request body must be in JSON format and should include the following parameter:
\nitems (Array of Objects): An array containing the notification items to be sent.
\nEach object in the array should have the following structure:
\nreceiverData (Object): Information about the receiver.
\nid (String): The unique identifier for the receiver.
\nAmount (String): The amount associated with the notification. (This is a dynamic data, defined in your notification configuration)
\n{\n \"items\": [\n {\n \"receiverData\": {\n \"id\": \"123456\",\n \"Amount\": \"200.5\"\n }\n }\n ]\n}\n\nUpon a successful request, the server will respond with a 201 Created status and a JSON object containing the following fields:
total (Integer): The total number of items processed.
\nlimit (Integer): The limit set for the number of items.
\noffset (Integer): The offset used for pagination.
\nitems (Array of Objects): An array containing the details of the processed notification items.
\nEach object in the items array will include:
\nid (String): The unique identifier of the notification item.
\nnotificationGroupId (String): The ID of the notification group.
\nreceiverData (Object): The data of the receiver.
\nid (Integer): The unique identifier for the receiver.
\nAmount (String): The amount associated with the notification.
\n_id (String): Internal identifier for the item.
\nstatus (String): The current status of the notification.
\ncreatedAt (String): Timestamp of when the notification was created.
\nsentAt (String|null): Timestamp of when the notification was sent.
\nreceivedAt (String|null): Timestamp of when the notification was received.
\nreadAt (String|null): Timestamp of when the notification was read.
\n{\n \"total\": 0,\n \"limit\": 0,\n \"offset\": 0,\n \"items\": [\n {\n \"id\": \"\",\n \"notificationGroupId\": \"\",\n \"receiverData\": {\n \"id\": 0,\n \"Amount\": \"\",\n \"_id\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"sentAt\": null,\n \"receivedAt\": null,\n \"readAt\": null\n }\n ]\n}\n\nEnsure that the Content-Type header is set to application/json.
The request must include proper authorization credentials.
\nThe endpoint is designed to handle bulk notifications efficiently, reducing the number of requests needed to send notifications to multiple receivers.
\nThis endpoint retrieves the details of a specific notification item within a given notification group for an organization. It is useful for obtaining information about notifications sent to users, including their status and timestamps.
\nMethod: GET
\nURL: {{api-host}}/api/v1/organizations/{{organization-id}}/notifications/{{notification-group-id}}/items/{{_item-id}}
organization-id: The unique identifier of the organization.
notification-group-id: The unique identifier of the notification group.
_item-id: The unique identifier of the notification item being retrieved.
Status Code: 200 OK
\nContent-Type: application/json
\nThe response will contain a JSON object with the following fields:
\nid: The unique identifier of the notification item.
notificationGroupId: The identifier of the notification group this item belongs to.
receiverData: An object containing details about the receiver of the notification:
_id: The unique identifier of the receiver.
id: A numerical identifier associated with the receiver.
Amount: The amount related to the notification, if applicable.
status: The current status of the notification item (e.g., sent, received).
createdAt: The timestamp when the notification item was created.
sentAt: The timestamp when the notification was sent.
receivedAt: The timestamp when the notification was received.
readAt: The timestamp when the notification was read, if applicable.
{\n \"id\": \"\",\n \"notificationGroupId\": \"\",\n \"receiverData\": {\n \"_id\": \"\",\n \"id\": 0,\n \"Amount\": \"\"\n },\n \"status\": \"\",\n \"createdAt\": \"\",\n \"sentAt\": null,\n \"receivedAt\": null,\n \"readAt\": null\n}\n\nThis endpoint is essential for tracking the status and details of notifications within an organization, allowing for better management and understanding of communication with users.
\n","urlObject":{"path":["api","v1","organizations","{{organization-id}}","notifications","{{notification-group-id}}","items","{{_item-id}}"],"host":["{{api-host}}"],"query":[],"variable":[]}},"response":[{"id":"aa3238ba-fa6b-40d1-a8b3-71fa4eee8408","name":"success","originalRequest":{"method":"GET","header":[],"url":"{{api-host}}/api/v1/organizations/{{organization-id}}/notifications/{{notification-group-id}}/items/{{_item-id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"386"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Origin"},{"key":"X-Krakend","value":"Version 2.9.4"},{"key":"X-Krakend-Completed","value":"false"},{"key":"Date","value":"Sat, 21 Jun 2025 06:05:21 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"685642f6f700ec6242a168dc\",\n \"notificationGroupId\": \"fbd593e5-a53f-42cd-8b14-c04af742d904\",\n \"receiverData\": {\n \"_id\": \"9be0aab54c02eda6e22a5868ff61f509f5676da58f691b9e6efe9f96db82372e\",\n \"id\": 123456,\n \"Amount\": \"200.5\"\n },\n \"status\": \"FAILED\",\n \"createdAt\": \"2025-06-21T05:28:22.007916839\",\n \"sentAt\": null,\n \"receivedAt\": null,\n \"readAt\": null\n}"}],"_postman_id":"49db9853-413f-49f6-95ca-05840de057b7"}],"id":"a0bd8eea-a6ae-4fdd-a6a5-93de8815c16e","_postman_id":"a0bd8eea-a6ae-4fdd-a6a5-93de8815c16e","description":""},{"name":"PoV","item":[{"name":"enroll","item":[{"name":"InviteFlowGetChallenge","event":[{"listen":"test","script":{"id":"0887916a-328a-4cd8-aa0d-5a0429f31738","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);",""," const responseJson = pm.response.json();"," pm.environment.set(\"access-token\", responseJson.access_token);","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e8924968-9b27-487c-85ea-94486eb9d792","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"client-id","value":"blerify-dashboard"}],"body":{"mode":"raw","raw":"{\n \"code\": \"{{invite-flow-code}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auth-api-host}}/api/v1/auth/inviteFlow","description":"InviteFlowGetChallenge
\nThis endpoint initiates the invite flow authentication process by exchanging an invite code for an authentication challenge. It is typically the first step in the invite-based authentication sequence.
\nUse this endpoint to start the invite flow when a user has received an invite code. The endpoint validates the code and, if valid, returns an authentication challenge that must be solved in the next step.
\nMethod: POST
\nURL: {{auth-api-host}}/api/v1/auth/inviteFlow
code (string, required): The invite code received by the user. Example: {{invite-flow-code}}Example body:
\n{\n \"code\": \"{{invite-flow-code}}\"\n}\n\n{{auth-api-host}}: The base URL for the authentication API, set in your environment.
{{invite-flow-code}}: The invite code to be used, set in your environment or dynamically.
Success (200): Returns an authentication challenge object. The response typically includes a challenge that must be solved in the next step of the invite flow.
\nThe response body is parsed and the access_token (if present) is saved to the environment variable access-token.
new-code-already-sent: Example of a response when a new code has already been sent.
error-max-attempts-reached: Example of a response when the maximum number of attempts has been reached.
InviteFlowGetChallenge: This request (start of the invite flow).
\nInviteFlowSubmitChallenge: Next step, submit the challenge response to complete authentication.
\nUsage:
\nCall this endpoint with a valid invite code to receive a challenge.
\nUse the challenge in InviteFlowSubmitChallenge to complete the authentication process.
\nThis endpoint is essential for workflows where users are onboarded or authenticated via invitation codes.
\n","urlObject":{"path":["api","v1","auth","inviteFlow"],"host":["{{auth-api-host}}"],"query":[],"variable":[]}},"response":[{"id":"93415c28-aa18-4661-8365-4c465a327169","name":"error-max-attempts-reached","originalRequest":{"method":"POST","header":[{"key":"client-id","value":"blerify-dashboard"}],"body":{"mode":"raw","raw":"{\n \"code\": \"{{invite-flow-code}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auth-api-host}}/api/v1/auth/inviteFlow"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"66"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Origin"},{"key":"X-Krakend","value":"Version 2.9.4"},{"key":"X-Krakend-Completed","value":"false"},{"key":"Date","value":"Mon, 09 Jun 2025 02:51:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 11203,\n \"error\": \"max attempts have been reached\"\n}"},{"id":"713e8a9b-c1eb-49c1-ab06-d2f3fac5f2ca","name":"new-code-already-sent","originalRequest":{"method":"POST","header":[{"key":"client-id","value":"blerify-dashboard"}],"body":{"mode":"raw","raw":"{\n \"code\": \"{{invite-flow-code}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auth-api-host}}/api/v1/auth/inviteFlow"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"68"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Origin"},{"key":"X-Krakend","value":"Version 2.9.4"},{"key":"X-Krakend-Completed","value":"false"},{"key":"Date","value":"Wed, 11 Jun 2025 04:23:03 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 11208,\n \"error\": \"a new code has already been sent\"\n}"},{"id":"c7d7d26e-2ca3-44bd-b27f-712554f21996","name":"succesDidJwtGetChallenge","originalRequest":{"method":"POST","header":[{"key":"client-id","value":"blerify-dashboard"}],"body":{"mode":"raw","raw":"{\n \"code\": \"{{invite-flow-code}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{auth-api-host}}/api/v1/auth/inviteFlow"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"148"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Origin"},{"key":"X-Krakend","value":"Version 2.9.4"},{"key":"X-Krakend-Completed","value":"false"},{"key":"Date","value":"Mon, 16 Jun 2025 16:00:16 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"challengeType\": \"didJwt\",\n \"challenge\": \"iMYQGZIrT6W/LdPoTzs7OQ==\",\n \"signatureAlgorithms\": [\n -7\n ],\n \"rpId\": \"iam.staging.blerify.com\"\n}"}],"_postman_id":"e8924968-9b27-487c-85ea-94486eb9d792"},{"name":"InviteFlowSubmitChallenge","event":[{"listen":"test","script":{"id":"0887916a-328a-4cd8-aa0d-5a0429f31738","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);",""," const responseJson = pm.response.json();"," pm.environment.set(\"access-token\", responseJson.access_token);","});",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c71189e3-4fc3-4bac-a289-c1b4a07ff7de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"client-id","value":"blerify-dashboard"}],"body":{"mode":"raw","raw":"{\n \"code\": \"{{invite-flow-code}}\",\n \"challenge\": {\n \"type\": \"didJwt\",\n \"value\": \"eyJhbGciOiJFUzI1NksiLCJ0eXAiOiJKV1QifQ.eyJpYXQiOjE3NTE1MDU2MDMsImV4cCI6MzMyODMwNTYwMywic3ViIjoiZGlkOmxhYzE6MWlUNXp6allxUXRoeDc5c1cxaERjTXZTOUwzUVNxZnBnR1Y2QXFpR0JKcVNhb1BYMWtaN0RuU2RkaVVGNjFGUnFKRDUiLCJhdWQiOiJpYW0uc3RhZ2luZy5ibGVyaWZ5LmNvbSIsImlzcyI6ImRpZDpsYWMxOjFpVDV6empZcVF0aHg3OXNXMWhEY012UzlMM1FTcWZwZ0dWNkFxaUdCSnFTYW9QWDFrWjdEblNkZGlVRjYxRlJxSkQ1IiwiY3VzdG9tQXR0cmlidXRlcyI6eyJjaGFsbGVuZ2UiOiIydXZXb2Q3WlJ1Q3piTjM1YTRsOWh3PT0ifX0.CCcUho24E9mEQyM9A2SUGJAKsW-hzT6o76mWYqV9-rsODfAAyT5aChftPXeQ6YQsCnh6GwYtve5ZO2XeEBnmlBs\"\n } \n}","options":{"raw":{"language":"json"}}},"url":"{{auth-api-host}}/api/v1/auth/inviteFlow","description":"Purpose:\nSubmits a challenge response as part of the invite flow authentication process. This endpoint is typically called after retrieving a challenge using the related InviteFlowGetChallenge endpoint.
\nRequest Body:
\ncode (string): The invite flow code, usually obtained from a prior step in the invite process.challenge (object): Contains the challenge response.type (string): The type of challenge, e.g., didJwt.value (string): The signed challenge value (such as a JWT).Returns:
\naccess_token) and other authentication details in the response body.Related Requests:
\nRetrieves a list of presentation verifications associated with the authenticated user's wallet. This GET endpoint returns all verification records, including their statuses and metadata, enabling users to track credential presentations and their verification outcomes.
\nType: Bearer Token (JWT)
\nHeader: Authorization: Bearer
The request requires a valid bearer token for authorization. Unauthorized requests will be rejected.
\nPath Parameters: None
\nQuery Parameters: None
\nHeaders:
\nAuthorization (required): Bearer token for authentication
Accept (optional): application/json, text/plain, \\\\*/\\\\*
correlation-id: unique id to identify this operation
Variables:
\napi-host (required): The base URL of the API (e.g., https://api.example.com)
access-token (required): The JWT used for authentication
Status Code: 200 OK (on success)
\nResponse Body: JSON array of presentation verification objects. Each object typically includes:
\nid: Unique identifier for the verification
status: Verification status (e.g., pending, verified, failed)
metadata: Additional information about the verification
createdAt, updatedAt: Timestamps
Reference Example: See the saved example \"success\" for a sample response.
\nOnly verifications associated with the authenticated user's wallet are returned.
\nEnsure the api-host and access-token variables are correctly set in your environment or collection.
The endpoint may return an empty array if no verifications exist.
\nFor error responses (e.g., 401 Unauthorized), ensure your bearer token is valid and not expired.
\nValidates a specific credential associated with a presentation verification against the registry.
\nPurpose: Confirms the authenticity and status of a credential by providing the required presentation verification ID and credential ID as path variables.
\nPath Parameters:
\n_presentation-verification-id: The unique identifier for the rule associated to the Point of verification.
\ncredential-id: The unique identifier of the credential to be validated.
\nVariables:
\nPossible Responses:
\n200 OK: Credential is valid and recognized by the registry.
\n400 Bad Request: Invalid or missing parameters.
\n404 Not Found: Credential or presentation verification not found.
\n500 Internal Server Error: Unexpected server error.
\nEnsure all variables are set appropriately before making the request.
\n","urlObject":{"path":["api","v1","wallet","presentationverifications","{{_presentation-verification-id}}","credentials","{{credential-id}}","verify","registry"],"host":["{{api-host}}"],"query":[],"variable":[]}},"response":[{"id":"56a5c8b7-8fa0-4410-a8a7-df389abdfdbc","name":"success","originalRequest":{"method":"GET","header":[],"url":"{{api-host}}/api/v1/wallet/presentationverifications/{{_presentation-verification-id}}/credentials/{{credential-id}}/verify/registry"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"393"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Origin"},{"key":"X-Krakend","value":"Version 2.9.4"},{"key":"X-Krakend-Completed","value":"false"},{"key":"Date","value":"Thu, 17 Jul 2025 02:13:49 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"registered\": true,\n \"onHold\": false,\n \"expired\": false,\n \"revoked\": false,\n \"revokedAt\": null,\n \"reason\": null,\n \"issuance\": {\n \"protocol\": \"WALLET\",\n \"issuedAt\": \"2025-07-16T22:22:07\",\n \"transactionHash\": \"http://35.188.10.56:3000/tx/0xd29f63508fabef6694f7249b49aef7b91dba2d910d58e7f34536583e90bd387f\",\n \"blockNumber\": 8097,\n \"network\": \"AVALANCHE\"\n }\n}"},{"id":"2b927d0b-c6c6-4ef6-9da2-7258c818adc7","name":"illegal-arguments","originalRequest":{"method":"GET","header":[],"url":"{{api-host}}/api/v1/wallet/presentationverifications/{{_presentation-verification-id}}/credentials/{{credential-id}}/verify/registry"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\" : 40001,\n \"error\" : \"Illegal argument parameters\"\n}"}],"_postman_id":"290ca31f-0345-4935-b848-377f7401f5a8"},{"name":"GetCertificates","id":"b98074ce-8355-424e-b13f-65ae457f44d2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"host":true,"user-agent":true,"accept":true,"accept-encoding":true,"connection":true}},"request":{"method":"GET","header":[],"url":"{{cdn_hostname}}/certificates/{{trusted_list}}","description":"Retrieves a list of trusted certificates in JWK (JSON Web Key) format from the specified CDN.
\nPurpose:
Fetches all certificates associated with a given trusted list, typically used for signature verification or cryptographic operations.
Request Parameters:
\ncdn_hostname (path or environment variable): The base hostname of the CDN where certificates are hosted.
trusted_list (path or environment variable): The identifier for the trusted list whose certificates you want to retrieve.
Request Example:
\nGET {{cdn_hostname}}/certificates/{{trusted_list}}\n\nResponse Structure:
Returns an array of objects. Each object contains:
data: An object with JWK fields:
alg: Algorithm (e.g., \"ES256\")
crv: Curve (e.g., \"P-256\")
kid: Key ID
kty: Key type (e.g., \"EC\")
use: Intended use (e.g., \"sig\")
x, y: Public key coordinates
x5c: Array of X.509 certificate chains
x5t#S256: X.509 certificate SHA-256 thumbprint
type: Always \"jwk\"
version: Version string (e.g., \"1.0.0\")
Sample Response:
\n[\n {\n \"data\": {\n \"alg\": \"ES256\",\n \"crv\": \"P-256\",\n \"kid\": \"kUWPnAjvBdLWCqQAFNgsAVHlqVajGmZUPA\",\n \"kty\": \"EC\",\n \"use\": \"sig\",\n \"x\": \"...\",\n \"y\": \"...\",\n \"x5c\": [\"...\"],\n \"x5t#S256\": \"...\"\n },\n \"type\": \"jwk\",\n \"version\": \"1.0.0\"\n },\n ...\n]\n\n