{"info":{"_postman_id":"80b9d255-a90b-45c3-a06a-4ae694601112","name":"VerifyEd External APIs","description":"

This collection of APIs allows you to automate many actions in VerifyEd.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15297252","collectionId":"80b9d255-a90b-45c3-a06a-4ae694601112","publishedId":"UVJhBtg5","public":true,"customColor":{"top-bar":"Ffffff","right-sidebar":"212121","highlight":"4567DA"},"publishDate":"2021-12-03T10:32:55.000Z"},"item":[{"name":"Get a list of all courses that exist (Institution or Automation Partner)","id":"04e10e8f-9133-4a66-8761-2b9baa03be7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.verifyed.io/external/courses?apiKey=YOUR-API-KEY-HERE&type=institution","description":"

This endpoint allows you to get a list of all the courses that an institution has created. You can retrieve your own courses as an institution or, if you're an automation partner, you can retrieve an institution's courses (if they've enabled you as a trusted partner).

Use this endpoint if:

You want to retrieve a list of existing courses
You are an institution acting on behalf of yourself
You are an automation partner acting on behalf of an institution that has enabled you as a trusted automation partner

\n","urlObject":{"protocol":"https","path":["external","courses"],"host":["api","verifyed","io"],"query":[{"key":"apiKey","value":"YOUR-API-KEY-HERE"},{"description":{"content":"

Let us know who is calling this API endpoint. If you're an institution accessing your own records, use institution. If you are an automation partner accessing an institution's records, use partner.

\n","type":"text/plain"},"key":"type","value":"institution"},{"disabled":true,"description":{"content":"

If you're an automation partner, you also need to send us the ID of the institution that you want to access records on behalf of.

\n","type":"text/plain"},"key":"instId","value":"2"}],"variable":[]}},"response":[],"_postman_id":"04e10e8f-9133-4a66-8761-2b9baa03be7d"},{"name":"Get a specific course by its ID (Institution or Automation Partner)","id":"a0618e56-1979-49cd-96f6-b9edc4c46dc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.verifyed.io/external/course/[courseId]?apiKey=YOUR-API-KEY-HERE&type=institution","description":"

This endpoint allows you to get a specific course that an institution has created. You can retrieve your own course as an institution or, if you're an automation partner, you can retrieve an institution's course (if they've enabled you as a trusted partner).

Note that you have to supply the course's ID in the URL at the end of the route, for example: https://api.verifyed.io/external/course/123

Use this endpoint if:

You want to retrieve a single course which already exists
You are an institution acting on behalf of yourself
You are an automation partner acting on behalf of an institution that has enabled you as a trusted automation partner

\n","urlObject":{"protocol":"https","path":["external","course","[courseId]"],"host":["api","verifyed","io"],"query":[{"key":"apiKey","value":"YOUR-API-KEY-HERE"},{"description":{"content":"

\n","type":"text/plain"},"key":"type","value":"institution"},{"disabled":true,"description":{"content":"

If you're an automation partner, you also need to send us the ID of the institution that you want to access records on behalf of.

\n","type":"text/plain"},"key":"instId","value":"2"}],"variable":[]}},"response":[],"_postman_id":"a0618e56-1979-49cd-96f6-b9edc4c46dc1"},{"name":"Get a specific credential by its ID (Institution or Automation Partner)","id":"3e3c39b6-ebde-4ae3-a469-59edca64bc6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.verifyed.io/external/credential/[credentialId]?apiKey=YOUR-API-KEY-HERE&type=institution","description":"

This endpoint allows you to get a specific credential that an institution has created. You can retrieve your own credential as an institution or, if you're an automation partner, you can retrieve an institution's credential (if they've enabled you as a trusted partner).

The response of this endpoint is in the Open Badge 2.0 format.

Note that you have to supply the course's ID in the URL at the end of the route, for example: https://api.verifyed.io/external/credential/123

Use this endpoint if:

You want to retrieve a single credential which already exists
You know the ID of the credential you want to retrieve
You are an institution acting on behalf of yourself
You are an automation partner acting on behalf of an institution that has enabled you as a trusted automation partner

\n","urlObject":{"protocol":"https","path":["external","credential","[credentialId]"],"host":["api","verifyed","io"],"query":[{"key":"apiKey","value":"YOUR-API-KEY-HERE"},{"description":{"content":"

\n","type":"text/plain"},"key":"type","value":"institution"},{"disabled":true,"description":{"content":"

If you're an automation partner, you also need to send us the ID of the institution that you want to access records on behalf of.

\n","type":"text/plain"},"key":"instId","value":"2"}],"variable":[]}},"response":[],"_postman_id":"3e3c39b6-ebde-4ae3-a469-59edca64bc6a"},{"name":"Issue credentials for an existing course without additional information (Institution or Automation Partner)","id":"6de8bf97-ff33-41e1-b51f-dfe5b1ea71dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"templateId\":\"your-template-id\",\n \"courseId\": \"course-id\",\n \"learningPathwayId\": \"pathway-id\",\n \"public\": true,\n \"studentData\": [\n {\n \"email\": \"person@your-institution.com\",\n \"name\": \"John Doe\",\n \"outcome\": \"learner-outcome\",\n \"completionDate\": \"2022-02-03T10:11:17.227Z\",\n \"additionalInfo\": []\n },\n {\n \"email\": \"person@your-institution.com\",\n \"name\": \"Jane Doe\",\n \"outcome\": \"learner-outcome\",\n \"completionDate\": \"2022-02-03T10:11:17.227Z\",\n \"additionalInfo\": []\n },\n {\n \"email\": \"person@your-institution.com\",\n \"name\": \"Jacob Doe\",\n \"outcome\": \"learner-outcome\",\n \"completionDate\": \"2022-02-03T10:11:17.227Z\",\n \"additionalInfo\": []\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verifyed.io/external/issue-credentials?apiKey=YOUR-API-KEY-HERE&type=institution","description":"

This endpoint allows you to issue credentials for a course you've already created in VerifyEd.

Use this endpoint if:

You have already created the course you want to issue for.
You know the course's ID in VerifyEd (it's listed next to the course names).
You know the template ID you want to use.
You want to issue a certificate with no additional custom information fields.
You are an institution acting on behalf of yourself.
You are an automation partner acting on behalf of an institution that has enabled you as a trusted automation partner.

If you just want to create credentials without sending an email notification to a learner, you can leave the email field in studentData as null. This will still create an account and a credential, but the learner will not be informed via email. You can later invite the learner to sign up for their account.

The dateOfIssuance field must contain a standard ISO date formatted string.

The learningPathwayId field can contain a Learning Pathway ID (numeric) which a course is associated with, or have the value null if the issuance is not related to a Learning Pathway.

The public field controls whether the issued credentials will be public or private by default. public being true means the credentials will be public by default, whereas if it's false then they will be private to the learner by default.

Once you have issued your certificates via this endpoint, you will get a response like:

{\n    message: \"3 certificate(s) have been issued successfully, your learners will be notified via email in the next few minutes.\",\n    learnerData: [\n        {\n            name: \"Michael Fordham\",\n            email: \"example1@domain.com\",\n            certificateLink: \"https://www.verifyed.io/certificate/uniqueid1\"\n        },\n        {\n            name: \"Bukola Omosefunmi\",\n            email: \"example2@domain.com\",\n            certificateLink: \"https://www.verifyed.io/certificate/uniqueid2\"\n        },\n        {\n            name: \"Abigail Waterer\",\n            email: \"example3@domain.com\",\n            certificateLink: \"https://www.verifyed.io/certificate/uniqueid3\"\n        }\n    ],\n    warnings: []\n}\n\n

If you've tried to issue to an account which is already linked to an institutional admin account, there will be an additional property in the response named warnings which will explain why any specific certificates were not issued.

\n","urlObject":{"protocol":"https","path":["external","issue-credentials"],"host":["api","verifyed","io"],"query":[{"key":"apiKey","value":"YOUR-API-KEY-HERE"},{"description":{"content":"

\n","type":"text/plain"},"key":"type","value":"institution"},{"disabled":true,"description":{"content":"

If you're an automation partner, you also need to send us the ID of the institution that you want to access records on behalf of.

\n","type":"text/plain"},"key":"instId","value":"2"}],"variable":[]}},"response":[],"_postman_id":"6de8bf97-ff33-41e1-b51f-dfe5b1ea71dd"},{"name":"Issue a credential for an existing course with additional information (Institution or Automation Partner)","id":"8a2134b0-6b3c-415b-86a3-e46149c4d477","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"templateId\":\"your-template-id\",\n \"courseId\": \"course-id\",\n \"learningPathwayId\": \"pathway-id\",\n \"public\": true,\n \"studentData\": [\n {\n \"email\": \"person@your-institution.com\",\n \"name\": \"John Doe\",\n \"outcome\": \"learner-outcome\",\n \"completionDate\": \"2022-02-03T10:11:17.227Z\",\n \"additionalInfo\": [\n {\n \"label\": \"Rank\",\n \"data\": \"Gold\"\n },\n {\n \"label\": \"Pathway\",\n \"data\": \"Engineering\"\n },\n {\n \"label\": \"Semester\",\n \"data\": \"3\"\n }\n ]\n },\n {\n \"email\": \"person@your-institution.com\",\n \"name\": \"Jane Doe\",\n \"outcome\": \"learner-outcome\",\n \"completionDate\": \"2022-02-03T10:11:17.227Z\",\n \"additionalInfo\": [\n {\n \"label\": \"Rank\",\n \"data\": \"Gold\"\n },\n {\n \"label\": \"Pathway\",\n \"data\": \"Engineering\"\n },\n {\n \"label\": \"Semester\",\n \"data\": \"3\"\n }\n ]\n },\n {\n \"email\": \"person@your-institution.com\",\n \"name\": \"Jacob Doe\",\n \"outcome\": \"learner-outcome\",\n \"completionDate\": \"2022-02-03T10:11:17.227Z\",\n \"additionalInfo\": [\n {\n \"label\": \"Rank\",\n \"data\": \"Gold\"\n },\n {\n \"label\": \"Pathway\",\n \"data\": \"Engineering\"\n },\n {\n \"label\": \"Semester\",\n \"data\": \"3\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verifyed.io/external/issue-credentials?apiKey=YOUR-API-KEY-HERE&type=partner","description":"

This endpoint allows you to issue credentials for a course you've already created in VerifyEd.

Use this endpoint if:

You have already created the course you want to issue for.
You know the course's ID in VerifyEd (it's listed next to the course names).
You know the template ID you want to use.
You want to issue a certificate with no additional custom information fields.
You are an institution acting on behalf of yourself.
You are an automation partner acting on behalf of an institution that has enabled you as a trusted automation partner.

What is the additionalInfo field?

The additionalInfo field contains an array of objects which have the properties label and data. You can have as many objects as you like in this array - but each one must have a label property and a data property with data related to them.

For example, if you wanted to display the semester the learner earned the achievement for, your additionalInfo array would look like this:

[ { \"label\": \"Semester\", \"data\": \"3\" } ]

The dateOfIssuance field must contain a standard ISO date formatted string.

The learningPathwayId field can contain a Learning Pathway ID (numeric) which a course is associated with, or have the value null if the issuance is not related to a Learning Pathway.

Once you have issued your certificates via this endpoint, you will get a response like:

{\n    message: \"3 certificate(s) have been issued successfully, your learners will be notified via email in the next few minutes.\",\n    learnerData: [\n        {\n            name: \"Michael Fordham\",\n            email: \"example1@domain.com\",\n            certificateLink: \"https://www.verifyed.io/certificate/uniqueid1\"\n        },\n        {\n            name: \"Bukola Omosefunmi\",\n            email: \"example2@domain.com\",\n            certificateLink: \"https://www.verifyed.io/certificate/uniqueid2\"\n        },\n        {\n            name: \"Abigail Waterer\",\n            email: \"example3@domain.com\",\n            certificateLink: \"https://www.verifyed.io/certificate/uniqueid3\"\n        }\n    ],\n    warnings: []\n}\n\n

\n","urlObject":{"protocol":"https","path":["external","issue-credentials"],"host":["api","verifyed","io"],"query":[{"key":"apiKey","value":"YOUR-API-KEY-HERE"},{"key":"type","value":"partner"},{"disabled":true,"description":{"content":"

If you're an automation partner, you also need to send us the ID of the institution that you want to access records on behalf of.

\n","type":"text/plain"},"key":"instId","value":"2"}],"variable":[]}},"response":[],"_postman_id":"8a2134b0-6b3c-415b-86a3-e46149c4d477"},{"name":"Create a course (Institution or Automation Partner)","id":"b6571e0e-d567-408f-843f-78444a927e43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"name\": \"Test course\",\n \"information\": \"This course covers the fundamentals of testing science.\",\n \"courseskills\": [\n {\n \"level\": 3,\n \"name\": \"Crafting\"\n },\n {\n \"level\": 2,\n \"name\": \"Research\"\n }\n ],\n \"validity\": {\n \"validityNumber\": 10,\n \"validityLength\": \"year(s)\"\n },\n \"durationValues\": {\n \"durationNumber\": 1,\n \"durationLength\": \"year(s)\"\n },\n \"courseLink\": \"https://www.test.com\",\n \"courseCode\": \"TESTMGT001\",\n \"referencedCourses\": [],\n \"bodyText\": \"It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English.\",\n \"additionalInfo\": [\n {\n \"label\": \"Location\",\n \"data\": \"Offline\"\n },\n {\n \"label\": \"Study Mode\",\n \"data\": \"Independent Research\"\n }\n ]\n }","options":{"raw":{"language":"json"}}},"url":"https://api.verifyed.io/external/courses?apiKey=YOUR-API-KEY-HERE&type=institution","description":"

This endpoint allows you to create a course in VerifyEd.

Use this endpoint if:

You want to create a course
You are an institution acting on behalf of yourself
You are an automation partner acting on behalf of an institution that has enabled you as a trusted automation partner

What is the additionalInfo field?

For example, if you wanted to display the semester the learner earned the achievement for, your additionalInfo array would look like this:

[ { \"label\": \"Semester\", \"data\": \"3\" } ]

What is the courseskills field?

The courseskills field contains an array of objects which have the properties name and level of each skill that will be acquired by the learners taking the course. You can have as many objects as you like in this field - but each one must have a name property and a level property with data related to them.

\n","urlObject":{"protocol":"https","path":["external","courses"],"host":["api","verifyed","io"],"query":[{"key":"apiKey","value":"YOUR-API-KEY-HERE"},{"description":{"content":"

\n","type":"text/plain"},"key":"type","value":"institution"},{"disabled":true,"description":{"content":"

If you're an automation partner, you also need to send us the ID of the institution that you want to access records on behalf of.

\n","type":"text/plain"},"key":"instId","value":"2"}],"variable":[]}},"response":[],"_postman_id":"b6571e0e-d567-408f-843f-78444a927e43"},{"name":"Alert VerifyEd of automation interest (Automation Partner)","id":"1ca05e32-545c-41a7-b2bc-8e62e05c2546","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"interestInfo\": \"(Institution Name) wants to start issuing credentials. You should contact (person's email) to set up their account.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verifyed.io/external/register-interest?apiKey=YOUR-API-KEY-HERE","description":"

This endpoint allows you to inform VerifyEd that one of your client institutions wants to begin issuing credentials.

Use this endpoint if:

You are an automation partner
Your client wants to indicate they are interested in issuing credentials via your platform

What data should I send in interestInfo ?

This field just accepts a string value. We recommend inserting your client's data in the format we've provided, but if you want/need to share more or less information that is also possible.

What happens after we call this endpoint?

VerifyEd is notified that your client wants to issue credentials via your platform, and so our team will reach out to understand the needs and set up their account. This will typically happen within 24 hours of a notification being recieved.

\n","urlObject":{"protocol":"https","path":["external","register-interest"],"host":["api","verifyed","io"],"query":[{"key":"apiKey","value":"YOUR-API-KEY-HERE"}],"variable":[]}},"response":[],"_postman_id":"1ca05e32-545c-41a7-b2bc-8e62e05c2546"},{"name":"Get all institutions connected to a partner (Automation Partner)","id":"89b5b0d7-c4eb-45c5-9062-1c9ab68f5054","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"YOUR-API-KEY-HERE\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verifyed.io/external/automation/partners","description":"

This endpoint allows you to get all institutions that have enabled their partnerships with you.

Use this endpoint if:

You are an automation partner

What data should I send in apiKey ?

This field just accepts a string value. We recommend inserting the aAPIpi key that was provided to you when your account was created.

What happens after we call this endpoint?

VerifyEd is notified that your you want to view a list of all your clients then we send you an array containing all the institutions connected to you.

\n","urlObject":{"protocol":"https","path":["external","automation","partners"],"host":["api","verifyed","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"89b5b0d7-c4eb-45c5-9062-1c9ab68f5054"},{"name":"Get all certificates for an institution in the Open Badge format (Institution)","id":"19a6300d-49bd-4331-a7c9-136bd3667305","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"apiKey\": \"YOUR-API-KEY-HERE\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verifyed.io/external/credentials/openbadge?type=institution","description":"

This endpoint allows you to get all certificates that have been issued by an institution in the open badge JSON format.

Use this endpoint if:

You are an institution

What data should I send in apiKey ?

This field just accepts a string value. We recommend inserting the API key that was provided to you when your account was created.

What happens after we call this endpoint?

VerifyEd is notified that you want to view a list of all certificates that have been issued to learners via your institution in an open badge format then we send you an array containing all the certificates to you.

\n","urlObject":{"protocol":"https","path":["external","credentials","openbadge"],"host":["api","verifyed","io"],"query":[{"description":{"content":"

This indicates you are calling the API on behalf of yourself, as an institution.

\n","type":"text/plain"},"key":"type","value":"institution"}],"variable":[]}},"response":[],"_postman_id":"19a6300d-49bd-4331-a7c9-136bd3667305"},{"name":"Get all certificate templates (Institution or Automation Partner)","id":"8ca53e1a-ebeb-4505-9eda-ea23661f2090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.verifyed.io/external/certificates/templates?apiKey=your-api-key&type=institution","description":"

This endpoint allows you to get all the certificate templates belonging to your institution or an institution connected to you (if you are a partner).

Use this endpoint if:

You are an institution
Or you are a partner connected to an institution

What data should I send in apiKey, type, institution ?

The apiKey field accepts a string value. You can get your API key from your institutional dashboard. If you are an automation partner and do not know your API key, contact us directly.

The type field is the type of client you are which is either an 'institution' or a 'partner'.

The institution field is the institution ID you want to act on behalf of. Only automation partners need to include this field, institutions do not.

What happens after we call this endpoint?

VerifyEd is notified that you want to view a list of all certificate templates that have been created via your institution then we send you an array containing all the key information about the certificate templates.

\n","urlObject":{"protocol":"https","path":["external","certificates","templates"],"host":["api","verifyed","io"],"query":[{"key":"apiKey","value":"your-api-key"},{"key":"type","value":"institution"},{"disabled":true,"key":"instId","value":"your-inst-id"}],"variable":[]}},"response":[],"_postman_id":"8ca53e1a-ebeb-4505-9eda-ea23661f2090"}],"event":[{"listen":"prerequest","script":{"id":"815ef170-4b42-4f0b-b9eb-ea01ed124026","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c644ee2e-091e-41a6-8c4b-d9f0a692091d","type":"text/javascript","exec":[""]}}]}