The NetCredential API is a REST-styled interface, providing programmatic access to much of the data in the system. It provides predictable URLs for accessing resources, and uses built-in HTTP features to receive commands and return responses. This makes it easy to communicate from a wide variety of environments: command-line utilities, gadgets, and even the browser URL bar itself.
\nThe API accepts JSON content in requests and returns JSON content in all of its responses, including errors. Only UTF-8 character encoding is supported for both requests and responses.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"38431373","collectionId":"49bff3da-cd6f-4572-aa3a-9c909b2c1234","publishedId":"2sAYQZJY3S","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-16T18:53:03.000Z"},"item":[{"name":"Get credential","id":"b81212f1-b4bd-4a31-8957-015a909a815b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.netcredential.com/v1/credential/:id","description":"Use this endpoint to get a specific credential.
\n","urlObject":{"protocol":"https","path":["v1","credential",":id"],"host":["api","netcredential","com"],"query":[],"variable":[{"description":{"content":"The unique ID of the credential.
\n","type":"text/plain"},"type":"any","value":"9pZHhPkbbt","key":"id"}]}},"response":[{"id":"c0d69856-1389-4d64-a85a-c0e8000f4673","name":"Get credential","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.netcredential.com/v1/credential/:id","protocol":"https","host":["api","netcredential","com"],"path":["v1","credential",":id"],"variable":[{"key":"id","value":"9pZHhPkbbt","description":"The unique ID of the credential."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Jan 2024 13:26:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"x-powered-by","value":"Phusion Passenger(R) 6.0.18","enabled":true},{"key":"x-powered-by","value":"PleskLin","enabled":true},{"key":"status","value":"200 OK","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=V5vsGltBOrL2g%2FOeoZMoGmWFIEAbp1%2FJC8bMMzewVSB0bExvwAD4r8bXH2zsT0FhB6pdfH0RRuxWdIW3KL%2FaUXRlvGptbjsTkF5351YV7Poy5tlK%2BmMhwRNmL%2FwyQ5%2BuDU1B6nSfDNk%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"840c0d915c1c3b83-IAD","enabled":true},{"key":"Content-Encoding","value":"br","enabled":true},{"key":"alt-svc","value":"h3=\":443\"; ma=86400","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\",\n \"credential\": {\n \"id\": \"9pZHhPkbbt\",\n \"group_id\": \"zqkqTzkjUTXg2ysCc0FhUuiIcJlT\",\n \"recipient\": {\n \"name\": \"Johnn Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"customAttributes\": {\n \"custom.course\": \"Artificial Intelligence\"\n },\n \"issueDate\": \"2023-12-31T18:30:00.000Z\",\n \"expiryDate\": \"2024-12-31T18:30:00.000Z\",\n \"status\": \"published\",\n \"created_at\": \"2024-01-05T13:22:37.793Z\",\n \"updated_at\": \"2024-01-05T13:22:37.793Z\"\n }\n}"}],"_postman_id":"b81212f1-b4bd-4a31-8957-015a909a815b"},{"name":"Add credential","id":"0eb6c932-48a4-406c-8095-d15eb9a805d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // The group’s ID you want to issue the credential to\n \"groupId\": \"zqkqTzkjUTXg2ysCc0FhUuiIcJlT\",\n // The recipient of the credential \n \"recipient\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n },\n // [Optional] The date of your credential issuance (by default is set to today, only YYYY-MM-DD format is allowed)\n \"issueDate\": \"2024-01-01\", \n // [Optional] The date of your credential's expiration (by default uses the group's settings, only YYYY-MM-DD format is allowed)\n \"expiryDate\": \"2025-01-01\", \n // [Optional] The key-value object of your custom attributes where key is your attribute's tag and value is just your value\n \"customAttributes\": {\n \"[custom.course]\": \"Artificial Intelligence\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netcredential.com/v1/credential","urlObject":{"protocol":"https","path":["v1","credential"],"host":["api","netcredential","com"],"query":[],"variable":[]}},"response":[{"id":"13b38fca-0c96-40ca-ad10-36437324f93c","name":"Add credential","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // The group’s ID you want to issue the credential to\n \"groupId\": \"zqkqTzkjUTXg2ysCc0FhUuiIcJlT\",\n // The recipient of the credential \n \"recipient\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n },\n // [Optional] The date of your credential issuance (by default is set to today, only YYYY-MM-DD format is allowed)\n \"issueDate\": \"2024-01-01\", \n // [Optional] The date of your credential's expiration (by default uses the group's settings, only YYYY-MM-DD format is allowed)\n \"expiryDate\": \"2025-01-01\", \n // [Optional] The key-value object of your custom attributes where key is your attribute's tag and value is just your value\n \"customAttributes\": {\n \"custom.course\": \"Artificial Intelligence\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netcredential.com/v1/credential"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Jan 2024 13:20:24 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"28","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"x-powered-by","value":"Phusion Passenger(R) 6.0.18","enabled":true},{"key":"status","value":"500 Internal Server Error","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=VfI%2FrhioMpAYzFS%2BxYRuCTXHLQV4Ifq%2BFAlDXHf9E93k99UbteJ8HP2g8yJXlQ2KnGS2oQwVQl%2FBjhp30NqZSnw5OozJbnRTX1eWmzH0xp9t9%2FUoqNzZkHrqw3%2F59F9vRprVlyaztbA%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"840c04b2aba51366-IAD","enabled":true},{"key":"alt-svc","value":"h3=\":443\"; ma=86400","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\",\n \"credentialId\": \"9pZHhPkbbt\"\n}"}],"_postman_id":"0eb6c932-48a4-406c-8095-d15eb9a805d5"},{"name":"Delete credential","id":"4199391b-bb41-40ef-b676-f3a652de622b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.netcredential.com/v1/credential/:id","urlObject":{"protocol":"https","path":["v1","credential",":id"],"host":["api","netcredential","com"],"query":[],"variable":[{"description":{"content":"The unique ID of the credential
\n","type":"text/plain"},"type":"any","value":"9pZHhPkbbt","key":"id"}]}},"response":[{"id":"39d2fbc4-0bbf-4b0e-8826-6487a8566d6d","name":"Delete credential","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.netcredential.com/v1/credential/:id","protocol":"https","host":["api","netcredential","com"],"path":["v1","credential",":id"],"variable":[{"key":"id","value":"9pZHrn2Dus","description":"The unique ID of the credential"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Jan 2024 13:37:40 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"21","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"x-powered-by","value":"Phusion Passenger(R) 6.0.18","enabled":true},{"key":"x-powered-by","value":"PleskLin","enabled":true},{"key":"status","value":"200 OK","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=ElkDt%2Bv7zgXqastKDhVz86nXdCFiXzDNT%2BYiRxlLYtVQg8HbqPpQ%2BhzlVPEpb9GK%2BamZ8DkF%2BLf5gPn502JxPlgPOiZk6XMCtzIS4pAVKfqj9fB1BnplzssNRR23tkLxqFpkPK7zWd8%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"840c1dfeef8c3ae0-IAD","enabled":true},{"key":"alt-svc","value":"h3=\":443\"; ma=86400","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\"\n}"}],"_postman_id":"4199391b-bb41-40ef-b676-f3a652de622b"},{"name":"Update credential","id":"067a0f6a-0f5b-4584-8283-cffaac9cab31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n // [NOTE: All fields optional. Only pass the data that you want to update]\n // The recipient of the credential \n \"recipient\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n },\n // The date of your credential issuance (by default is set to today, only YYYY-MM-DD format is allowed)\n \"issueDate\": \"2024-01-01\", \n // The date of your credential's expiration (by default uses the group's settings, only YYYY-MM-DD format is allowed). Set to null if you want to reset this field.\n \"expiryDate\": \"2025-01-01\", \n // The key-value object of your custom attributes where key is your attribute's tag and value is just your value\n \"customAttributes\": {\n \"[custom.course]\": \"Artificial Intelligence\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.netcredential.com/v1/credential/:id","urlObject":{"protocol":"https","path":["v1","credential",":id"],"host":["api","netcredential","com"],"query":[],"variable":[{"description":{"content":"The unique ID of the credential
\n","type":"text/plain"},"type":"any","value":"9pZHhPkbbt","key":"id"}]}},"response":[{"id":"840a6cf7-a62b-4030-a251-311f5581226a","name":"Update credential","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n // [NOTE: All fields optional. Only pass the data that you want to update]\n // The recipient of the credential \n \"recipient\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n },\n // The date of your credential issuance (by default is set to today, only YYYY-MM-DD format is allowed)\n \"issueDate\": \"2024-01-01\", \n // The date of your credential's expiration (by default uses the group's settings, only YYYY-MM-DD format is allowed). Set to null if you want to reset this field.\n \"expiryDate\": \"2025-01-01\", \n // The key-value object of your custom attributes where key is your attribute's tag and value is just your value\n \"customAttributes\": {\n \"custom.course\": \"Artificial Intelligence\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.netcredential.com/v1/credential/:id","protocol":"https","host":["api","netcredential","com"],"path":["v1","credential",":id"],"variable":[{"key":"id","value":"9pZHhPkbbt","description":"The unique ID of the credential"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 05 Jan 2024 13:45:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"34","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"x-powered-by","value":"Phusion Passenger(R) 6.0.18","enabled":true},{"key":"status","value":"404 Not Found","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=vMzOICDfLlIMkb9HONgYe04KiEVkd4ogQ0OIZmxV8rUg3n2UGfTWkrISpiNcp8jXgLbFf8y9cjJXwZ4q4Pmggppzo3dOMUwkERGufOWGDQ41RxonVUsHh%2BM7NgmL2n%2BAWW6h6baQ2vc%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"840c29d25e6a801e-IAD","enabled":true},{"key":"alt-svc","value":"h3=\":443\"; ma=86400","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\"\n}"}],"_postman_id":"067a0f6a-0f5b-4584-8283-cffaac9cab31"}]}