--------------------------------
\nBusiness-focused responsive interface
\n--------------------------------
\nIssued By
\nMuller, Walsh and Lockman
\n--------------------------------
\nIssued On
\nOctober 7th, 2022
\n--------------------------------
\nExpires On
\n-
\n--------------------------------
\n \n" }, "proof": { "id": "urn:uuid:384b94ec-335f-4d42-a2c3-74d296f711da", "type": "MerkleProof2019", "cryptosuite": "merkle-proof-2019", "proofPurpose": "assertionMethod", "created": "2024-03-13T11:07:25.181722", "proofValue": "z8VhG6bxbkqU4L14xLgVfh1ctX985BaKbuHNwKECdsCLLgNgPBizqk5a9FwLE1XnP8QGTNoSfuXLPzAo2ARQ27icJ2CcekHcP71EkFd3wvRrWHdveP2ynYgyPFDS2Dpg2euzUWeMdbMoFHiQw31rfMvfbkyVhFv3bCxHmMj1sHa3S1eRPVvPzVeftU2DvuEPry3YfUYahZbWmc184G2ojWB2K4egND7yRhuFDumaQikVFSXmsKVXcYqpf6a6VWCRU9q4DmuPPxYhWXPtKb5FJVQjXeN7NWR7uJ5SUciewepf2Yo64CVPR8j2BcYMHSvSBBTgCh1wkUisvH947WKYS5z68R4fMS86DeLeBe1WuBiBHaYQV2hM7rt5Fb95dEAMAHAQNmACEFgy1BiK2V8prT18k8jPNDfKiifz1FRwrC5WXpsdJydJwnzJyuYV4TUWGFdVAB4T6hrP8wkkcy9UEjWBRJycNCCERRVPN7VCHH2bYqK1poYtKxncpCmByULodY8BwoX3xzAmJhvLTuEtpvipkF4sMySNrPMXHMZc1Lago8YofAWtswA9H7k4hWSdkzyuuF4HCNLoFjoepcz649PCiTgNhBxq8ynJtKmDESY4GWvtJTwmyfeEV1LvoQZmKgNZH8qe4WYJ3UeL96n3qjnVSbCqUFhEoxcDDofshhtz7YWTQUzS8ihnZc45gnXT2EeXeqE1Hyx6M98ig4TnAoXkzwDJ3KFoc25MqoRfovHdzAzFYjTp9Aa5ybT1iCC6nrUuSwqS1AHaKV4T88KxK5oxkMMQdeEvVcEtEMaVgSVXMhHuULb7dztBzonQRhem6s3v6AYYWHPH23nSVdDopTAAYGQqwZpaiBvXZnxTY85njJa3aT3tmfE7YutjjFmLAwC9cEMEM1dUSEW2NbaHyGVooc6kZnDjXxWZKWBBSx5ujoDPLiRgQrGbgN5aEFRRdYdEvYeCod6zJCgdzQ67coYFgKpkZC2RyYsYXuEwT4uve9M5vk6jDbj2nnXPFkAQhP6295k4UnT6oNZUJaWeBEmNm1BsDSPU7RFx45Js2p4hNG6N72oPHJDdKQn7hpCZt98MJWqtRzyx7XUZNmwPHjpYwFB3t1N7oa9NvA4EV2ahPUJHRP1tm7Xg4xafDRtRABSV5nxpbfnJAGZKjWUGGUCtz2NjLboc3vBP8g48MBbwRxZqvGTMF51eZ9F4D1VaEExAEcPLa3SdMxCby3XdfEbd9uqdEs2gr7qoMBFSHNQQAWGcxuVzd4h2mEwrerpbfFaTi5tq9dpJb6pKX2crAMyyWr8xfSZJvtq9dsuD1z2ZfKo3zwkciftwGzMsHxyF6Zm4XvJdCUG4fQntr6qTo91", "verificationMethod": "https://accredible.com" } } } } } }, "example2": { "value": { "data": { "chain": "Bitcoin", "credential_json_data": { "certificate": { "name": "Example Certificate Title", "issuer": { "name": "Example Organization", "url": "http://www.accredible.com", "id": "https://api.accredible.com/v1/obi/issuer_badge_classes/qOeq", "type": "Issuer", "email": "issuer+4897@accredible.com" }, "type": "Certificate", "id": "https://www.credential.net/10000005", "description": "This is an example description - you can write anything you want here. We recommend describing the achievement." }, "verify": { "signer": "abc", "attribute-signed": "uid", "type": "ECDSA(secp256k1)" }, "assertion": { "issuedOn": "2014-08-14", "type": "Assertion", "uid": "10000005-0000-0000-0000-000000000000", "id": "https://api.accredible.com/v1/obi/badge_assertions/akobz1" }, "type": "CertificateDocument", "@context": "https://w3id.org/blockcerts/v1", "recipient": { "familyName": "Jordan Smith", "hashed": true, "type": "email", "identity": "bUt3VFpyekE5Wmxxa0FRdExUZ3k5WkdVanRWU3JPNmxDVjdVZ2xkckJnVW9MVm5rYmtLSDZ6M3IvS2tMWnA5MS0tN0RwVVdIb1RJUzIyTnBjS20wcVpUdz09--d964109d91c7890715008e1749e0ee990c7ce9cb" } }, "receipt": { "@context": "https://w3id.org/chainpoint/v2", "type": "ChainpointSHA256v2", "targetHash": "726245b5a11b7f94b756ee746f3b3ce18efdc492c615c32678dae1ca76a8667a", "merkleRoot": "e9aaf5d6e0021deb260608991fbb45d1c3ccb4553ea710635975834909bd8314", "proof": [ { "left": "ab4f843e61e1261e832e97807f37d51d851f8aaac3f44216914f67b7588634ad" }, { "left": "91ad43d509dabfc0a6d23167a10707a63e8ab7f9fa949d6c0aca763c64fefdb6" }, { "right": "9047877604cecc72d9bc614375b14ff0ce02b231d51a53fe33ce24e39cf3e6c4" } ], "anchors": [ { "type": "BTCOpReturn", "sourceId": "707f86dc790338c5bddb19188c1c3f46f95a346a7693cc8c772b5e9252099c54" } ] } } } } } } } } }, "summary": "Verify BlockChain Credential (v2)", "operationId": "Verify BlockChain Credential (v2)", "description": "This endpoint gives data for a blockchain recorded credential.\nIt will help you verify authenticity of the credential on blockchain.\nThis endpoint would return different responses based on the Blockchain (*Bitcoin* or *Ethereum*) that it's issued in.\n\n[Verify Blockchain record of a Credential - Video Walkthrough](https://www.loom.com/share/23621ac848c44a77ac1eda0eeb975d93?sid=c10228b9-6317-477b-b903-20ed78ce6b76)", "tags": [ "Credentials" ], "parameters": [ { "name": "id", "in": "path", "description": "Encoded id or UUID of the credentials. unique id in the credentials url.", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "If private credentials provide a key", "required": false, "schema": { "type": "string" } } ], "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \\\n \"https://api.accredible.com/v2/credentials/12345/blockchain_data?key=12345\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\"" } ] } }, "/v1/credentials/analytics/{id}": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "analytics": { "type": "array", "items": { "type": "object", "properties": { "credential_id": { "type": "number" }, "event": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "credential_id", "event", "created_at" ] } } } }, "example": { "analytics": [ { "credential_id": 10533900, "event": "privacy_updated", "created_at": "2018-02-13T07:00:00.000Z" }, { "credential_id": 10533900, "event": "recipient_view_certificate", "created_at": "2018-02-13T07:00:00.000Z" }, { "credential_id": 10533900, "event": "credential_user_verified", "created_at": "2018-02-13T07:00:00.000Z" } ] } } } } }, "summary": "View Credential Analytics", "operationId": "View Credential Analytics", "description": "", "tags": [ "Credentials" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of the credential.", "required": true, "schema": { "type": "string" } } ], "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \\\n \"https://api.accredible.com/v1/credentials/analytics/12345\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\"" } ] } }, "/v1/credentials/{credential_id}/evidence_items": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "evidence_item": { "type": "object", "properties": { "id": { "type": "number" }, "description": { "type": "string" }, "link_url": { "type": "string" }, "preview_image_url": { "type": "string" }, "type": { "type": "string" }, "supplemental": { "type": "boolean" }, "string_object": { "nullable": true }, "position": { "type": "number" } } } } }, "example": { "evidence_item": { "id": 1234, "description": "updated description", "link_url": "https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf", "preview_image_url": "https://www.example.com/1234/reportcard.png", "type": "url", "supplemental": false, "string_object": null, "position": 1 } } } } } }, "summary": "Create a New Evidence Item", "operationId": "Create a New Evidence Item", "tags": [ "Evidence Items" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "Global ID of the credential in the form of an integer or string for the particular Credential requested.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "evidence_item": { "description": "Example file", "file": "https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf", "category": "file" } }, "schema": { "type": "object", "properties": { "evidence_item": { "type": "object", "properties": { "description": { "type": "string", "description": "Title text for the evidence item. This is displayed on a Credential." }, "category": { "type": "string", "enum": ["file", "url", "video", "grade", "transcript"], "description": "Type of Evidence Item added, must be one of [file, url, video, grade, transcript]. The type dictates how the item is displayed on the certificate." }, "url": { "type": "string", "description": "If the category is url or video, this should be the URL of Evidence Item." }, "file": { "type": "string", "description": "If the category is file, this should be the file's URL." }, "string_object": { "type": "string", "description": "If the category is grade or transcript then use it. For grade it will be just string 83." }, "preview": { "type": "string", "description": "By default if you add a URL category EvidenceItem, we take a screenshot to set the preview of this URL on Credential. You can overwrite this default behaviour by setting this preview field to be the URL of the desired image." }, "position": { "type": "number", "description": "The numeric position of the evidence item on the credential. 0 is displayed first in the list." }, "custom_insight": { "type": "string", "description": "The insights which will appear below Evidence Item, if not given it will be generated automatically based on data." } }, "required": ["description", "category"] } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \\\n \"https://api.accredible.com/v1/credentials/12345/evidence_items\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"evidence_item\": {\n \"description\": \"Example file\",\n \"file\": \"https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf\",\n \"category\": \"file\"\n }\n}'" } ] } }, "/v1/credentials/{credential_id}/evidence_items/{evidence_item_id}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "evidence_item": { "type": "object", "properties": { "id": { "type": "number" }, "description": { "type": "string" }, "link_url": { "type": "string" }, "preview_image_url": { "type": "string" }, "type": { "type": "string" }, "supplemental": { "type": "boolean" }, "string_object": { "nullable": true }, "position": { "type": "number" } } } } }, "example": { "evidence_item": { "id": 1234, "description": "updated description", "link_url": "https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf", "preview_image_url": "https://www.example.com/1234/reportcard.png", "type": "url", "supplemental": false, "string_object": null, "position": 1 } } } } } }, "summary": "View an Evidence Item", "operationId": "View an Evidence Item", "tags": [ "Evidence Items" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "ID of the Credential in the form of an integer or string for the particular Credential requested.", "required": true, "schema": { "type": "string" } }, { "name": "evidence_item_id", "in": "path", "description": "ID of the EvidenceItem in the form of an integer.", "required": true, "schema": { "type": "number" } } ], "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \\\n \"https://api.accredible.com/v1/credentials/12345/evidence_items/1234\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\"" } ] }, "put": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "evidence_item": { "type": "object", "properties": { "id": { "type": "number" }, "description": { "type": "string" }, "link_url": { "type": "string" }, "preview_image_url": { "type": "string" }, "type": { "type": "string" }, "supplemental": { "type": "boolean" }, "string_object": { "nullable": true }, "position": { "type": "number" } } } } }, "example": { "evidence_item": { "id": 1234, "description": "updated description", "link_url": "https://s3.amazonaws.com/accredible_api_evidence_items/files/44/original/1410743692307_Hours_Tracking.pdf", "preview_image_url": "https://www.example.com/1234/reportcard.png", "type": "url", "supplemental": false, "string_object": null, "position": 1 } } } } } }, "summary": "Update an Evidence Item", "operationId": "Update an Evidence Item", "tags": [ "Evidence Items" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "ID of the Credential in the form of a string or integer for the particular Credential requested.", "required": true, "schema": { "type": "string" } }, { "name": "evidence_item_id", "in": "path", "description": "ID of the Evidence Item in the form of an integer.", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "example": { "evidence_item": { "description": "updated description" } }, "schema": { "type": "object", "properties": { "evidence_item": { "type": "object", "properties": { "description": { "type": "string", "description": "Title text for the evidence item. This is displayed on a Credential." }, "category": { "type": "string", "enum": ["file", "url", "video", "grade", "transcript"], "description": "Type of Evidence Item added, must be one of [file, url, video, grade, transcript]. The type dictates how the item is displayed on the Credential." }, "url": { "type": "string", "description": "If the category is url or video, this should be the URL of Evidence Item." }, "file": { "type": "string", "description": "If the category is file, this should be the file's URL." }, "string_object": { "type": "string", "description": "If the category is grade or transcript then use it. For grade it will be just string 83." }, "preview": { "type": "string", "description": "By default if you add a URL category EvidenceItem, we take a screenshot to set the preview of this URL on Credentials. You can overwrite this default behaviour by setting this preview field to be the URL of the desired image." }, "position": { "type": "number", "description": "The numeric position of the evidence item on the credential. 0 is displayed first in the list." }, "custom_insight": { "type": "string", "description": "The insights which will appear below Evidence Item, if not given it will be generated automatically based on data." } }, "required": ["description", "category"] } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X PUT \\\n \"https://api.accredible.com/v1/credentials/12345/evidence_items/1234\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"evidence_item\": {\n \"description\": \"updated description\"\n }\n}'" } ] }, "delete": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "evidence_item": { "type": "object", "properties": { "id": { "type": "number" }, "description": { "type": "string" } } } } }, "example": { "evidence_item": { "id": 1234, "description": "Report card including all grades" } } } } } }, "summary": "Delete an Evidence Item", "operationId": "Delete an Evidence Item", "tags": [ "Evidence Items" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "ID of the Credential in the form of a string or integer for the particular Credential requested.", "required": true, "schema": { "type": "string" } }, { "name": "evidence_item_id", "in": "path", "description": "ID of the EvidenceItem in the form of an integer.", "required": true, "schema": { "type": "number" } } ], "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X DELETE \\\n \"https://api.accredible.com/v1/credentials/12345/evidence_items/1234\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\"" } ] } }, "/v1/credentials/{credential_id}/references": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "reference": { "type": "object", "properties": { "id": { "type": "number" }, "description": { "type": "string" }, "referee": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "avatar": { "type": "string" } } }, "supplemental": { "type": "boolean" }, "relationship": { "type": "string" } } } } }, "example": { "reference": { "id": 1234, "description": "John worked hard on this course and provided exemplary understanding of the core concepts", "referee": { "name": "Jane Doe", "email": "jdoe@example.com", "avatar": "https://www.example.com/avatars/janedoe.png" }, "supplemental": false, "relationship": "managed" } } } } } }, "summary": "Create a New Reference", "operationId": "Create a New Reference", "description": "You may create a Reference using this action. It takes a JSON object containing a Reference.", "tags": [ "References" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "ID of the Credential in the form of a string integer for the particular Credential requested.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "reference": { "description": "John worked hard on this course and provided exemplary understanding of the core concepts", "referee": { "name": "Jane Doe", "email": "person@example.com" }, "relationship": "managed" } }, "schema": { "type": "object", "properties": { "reference": { "type": "object", "properties": { "description": { "type": "string", "description": "The reference comments / text." }, "relationship": { "type": "string", "enum": ["taught", "managed", "mentored", "worked", "studied", "friends", "stranger", "professor"], "description": "Must be one of: \"taught\", \"managed\", \"mentored\", \"worked\", \"studied\", \"friends\", \"stranger\", \"professor\"." }, "referee": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the person providing the reference." }, "email": { "type": "string", "description": "Email of the person providing the reference." }, "avatar": { "type": "string", "description": "URL of image of the person providing the reference." }, "url": { "type": "string", "description": "URL of a social profile such as LinkedIn that would allow a viewer to learn more about the referee." } } }, "position": { "type": "number", "description": "The numeric position of the evidence item on the credential. 0 is displayed first in the list." } }, "required": ["description", "relationship"] } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X POST \\\n \"https://api.accredible.com/v1/credentials/12345/references\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"reference\": {\n \"description\": \"John worked hard on this course and provided exemplary understanding of the core concepts\",\n \"referee\": {\n \"name\": \"Jane Doe\",\n \"email\": \"person@example.com\"\n },\n \"relationship\": \"managed\"\n }\n}'" } ] } }, "/v1/credentials/{credential_id}/references/{reference_id}": { "get": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "reference": { "type": "object", "properties": { "id": { "type": "number" }, "description": { "type": "string" }, "referee": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "avatar": { "type": "string" } } }, "supplemental": { "type": "boolean" }, "relationship": { "type": "string" } } } } }, "example": { "reference": { "id": 1234, "description": "John worked hard on this course and provided exemplary understanding of the core concepts", "referee": { "name": "Jane Doe", "email": "jdoe@example.com", "avatar": "https://www.example.com/avatars/janedoe.png" }, "supplemental": false, "relationship": "managed" } } } } } }, "summary": "View a Reference", "operationId": "View a Reference", "tags": [ "References" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "ID of the Credential in the form of a string or integer for the particular Credential requested.", "required": true, "schema": { "type": "string" } }, { "name": "reference_id", "in": "path", "description": "ID of the Reference in the form of an integer.", "required": true, "schema": { "type": "number" } } ], "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X GET \\\n \"https://api.accredible.com/v1/credentials/12345/references/1234\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\"" } ] }, "put": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "reference": { "type": "object", "properties": { "id": { "type": "number" }, "description": { "type": "string" }, "referee": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "avatar": { "type": "string" } } }, "supplemental": { "type": "boolean" }, "relationship": { "type": "string" } } } } }, "example": { "reference": { "id": 1234, "description": "John worked hard on this course and provided exemplary understanding of the core concepts", "referee": { "name": "Jane Doe", "email": "jdoe@example.com", "avatar": "https://www.example.com/avatars/janedoe.png" }, "supplemental": false, "relationship": "managed" } } } } } }, "summary": "Update a Reference", "operationId": "Update a Reference", "tags": [ "References" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "ID of the Credential in the form of a string or integer for the particular Credential requested.", "required": true, "schema": { "type": "string" } }, { "name": "reference_id", "in": "path", "description": "ID of the Reference in the form of an integer.", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "example": { "reference": { "description": "my new reference text" } }, "schema": { "type": "object", "properties": { "reference": { "type": "object", "properties": { "description": { "type": "string", "description": "The reference comments / text." }, "relationship": { "type": "string", "enum": ["taught", "managed", "mentored", "worked", "studied", "friends", "stranger", "professor"], "description": "Must be one of: \"taught\", \"managed\", \"mentored\", \"worked\", \"studied\", \"friends\", \"stranger\", \"professor\"." }, "position": { "type": "number", "description": "The numeric position of the evidence item on the credential. 0 is displayed first in the list." } }, "required": ["description", "relationship"] } } } } } }, "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X PUT \\\n \"https://api.accredible.com/v1/credentials/12345/references/1234\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"reference\": {\n \"description\": \"my new reference text\"\n }\n}'" } ] }, "delete": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "reference": { "type": "object", "properties": { "id": { "type": "number" }, "description": { "type": "string" }, "referee": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "avatar": { "type": "string" } } }, "supplemental": { "type": "boolean" }, "relationship": { "type": "string" } } } } }, "example": { "reference": { "id": 1234, "description": "John worked hard on this course and provided exemplary understanding of the core concepts", "referee": { "name": "Jane Doe", "email": "jdoe@example.com", "avatar": "https://www.example.com/avatars/janedoe.png" }, "supplemental": false, "relationship": "managed" } } } } } }, "summary": "Delete a Reference", "operationId": "Delete a Reference", "tags": [ "References" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "ID of the Credential in the form of a string or integer for the particular Credential requested.", "required": true, "schema": { "type": "string" } }, { "name": "reference_id", "in": "path", "description": "ID of the Reference in the form of an integer.", "required": true, "schema": { "type": "number" } } ], "security": [ { "ApiKeyAuth": [] } ], "x-code-samples": [ { "lang": "cURL", "label": "cURL", "source": "curl -X DELETE \\\n \"https://api.accredible.com/v1/credentials/12345/references/1234\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\"" } ] } }, "/v1/issuer/groups": { "post": { "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "group": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "course_description": { "type": "string" }, "course_name": { "type": "string" }, "learning_outcomes": { "type": "array", "items": { "type": "string" } }, "attach_pdf": { "type": "boolean" }, "course_link": { "type": "string" }, "language": { "type": "string" }, "design_name": { "type": "string" }, "updated_at": { "type": "string" }, "created_at": { "type": "string" }, "design_id": { "type": "number" }, "blockchain": { "type": "boolean" }, "certificate_design_id": { "nullable": true }, "badge_design_id": { "nullable": true }, "primary_design_id": { "nullable": true }, "department_id": { "type": "number" }, "meta_data": { "type": "object", "properties": { "foo": { "type": "string" } } }, "generate_private_credential": { "type": "boolean" }, "auto_expiry": { "type": "number" }, "signup_url_show": { "type": "boolean" }, "signup_url": { "type": "string" }, "course_link_show": { "type": "boolean" }, "organization_link_show": { "type": "boolean" }, "skill_category": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "achievement_type": { "type": "string" }, "collections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "required": [ "id", "name", "description" ] } }, "earning_criteria": { "type": "array", "description": "Criteria the recipient must satisfy to earn this credential, ordered by `position`.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "achievement", "certificate", "competency", "completion", "course", "degree", "exam", "experience", "knowledge", "license", "participation", "reading", "skill", "specialization", "other" ] }, "text": { "type": "string" }, "required": { "type": "boolean" }, "position": { "type": "number" } }, "required": [ "id", "kind", "text", "required", "position" ] } } } } } }, "example": { "group": { "id": 12472, "name": "new group", "course_description": "Desscription of course", "course_name": "Intro to Programming", "learning_outcomes": [ "Skill One", "Skill Two" ], "attach_pdf": true, "course_link": "http://www.example.com", "language": "en", "design_name": "test", "updated_at": "2016-08-29T07:03:25.000Z", "created_at": "2016-08-29T06:14:18.000Z", "design_id": 23, "blockchain": false, "certificate_design_id": null, "badge_design_id": null, "primary_design_id": null, "department_id": 123, "meta_data": { "foo": "bar" }, "generate_private_credential": false, "auto_expiry": 1, "signup_url_show": false, "signup_url": "http://www.example.com", "course_link_show": false, "organization_link_show": false, "skill_category": { "id": 1, "name": "Example Category" }, "achievement_type": "Certificate", "collections": [ { "id": 1, "name": "one", "description": null }, { "id": 2, "name": "two", "description": "description example" } ], "earning_criteria": [ { "id": "8f3c0c8c-5e1b-4f2a-9c4a-1f2c5c3a0001", "kind": "course", "text": "Complete the Intro to Programming course", "required": true, "position": 1 }, { "id": "8f3c0c8c-5e1b-4f2a-9c4a-1f2c5c3a0002", "kind": "exam", "text": "Pass the final exam with 70% or higher", "required": true, "position": 2 } ] } } } } } }, "summary": "Create a Group", "operationId": "Create a Group", "description": "", "tags": [ "Groups" ], "requestBody": { "content": { "application/json": { "example": { "group": { "name": "new group", "course_name": "Intro to Prgramming", "course_description": "Description of course", "course_link": "http://www.example.com", "language": "en", "attach_pdf": true, "design_id": null, "blockchain": false, "certificate_design_id": null, "badge_design_id": null, "primary_design_id": null, "department_id": 123, "meta_data": { "batch_id": "271" }, "learning_outcomes": [ "Reading Books", "Writing Essays" ], "generate_private_credential": false, "auto_expiry": 1, "signup_url_show": false, "signup_url": "http://www.example.com", "course_link_show": false, "organization_link_show": false, "skill_category_id": 1, "achievement_type": "Certificate", "collections": [ { "id": 1 }, { "id": 2 } ], "earning_criteria": [ { "kind": "course", "text": "Complete the Intro to Programming course", "required": true, "position": 1 }, { "kind": "exam", "text": "Pass the final exam with 70% or higher", "required": true, "position": 2 } ] } }, "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the group (for your reference and never shown to the recipient)." }, "course_name": { "type": "string", "description": "Name of the course or achievement. This is visible to the recipient." }, "course_description": { "type": "string", "description": "Description of the course or achievement. This is visible to the recipient." }, "course_link": { "type": "string", "description": "Link to the web page with information related to this Credential. Typically this is a course information or event information page." }, "language": { "type": "string", "description": "Language for the group. Currently we support \"en\", \"es\", \"vi\", \"pt\", \"ja\", \"fr\", \"da\", \"nl\", \"fi\", \"no\", \"nb\", \"ro\", \"sv\", \"th\", \"tw\", \"zh\", \"tr\", \"ar\", \"he\", \"ms\" and \"de\". Default language is en." }, "attach_pdf": { "type": "boolean", "description": "PDF of the Credential should be attached to email when recipient is informed. Default is false." }, "blockchain": { "type": "boolean", "description": "Enable or disable recording of these Credentials on a Blockchain." }, "design_id": { "type": "number", "description": "DEPRECATED. Certificate Design which the Group will use to display Credentials." }, "certificate_design_id": { "type": "number", "description": "Certificate Design which the Group will use to display Credentials." }, "badge_design_id": { "type": "number", "description": "Badge Design which the Group will use to display Credentials." }, "primary_design_id": { "type": "number", "description": "Primary Design which the Group will use to display Credentials." }, "department_id": { "type": "number", "description": "Department that the group belongs to. If not defined the group will be assigned to the organizations default department." }, "meta_data": { "type": "object", "properties": {}, "description": "You can use this parameter to attach key-value strings to the object. Meta data is useful for storing additional, structured information on an object." }, "learning_outcomes": { "description": "Searchable keywords identifying skills credential-holders need to demonstrate (or have learned) in the process of earning this credential." }, "generate_private_credential": { "type": "boolean", "description": "The default value of `Credential.private` for the Group. The supported values are `true`, `false`, and `null`. When this is set to `true` or `false`, it will override `Department.generate_private_credential` and be used as the default of `Credential.private` when creating a new `Credential`. When this is set to `null`, it won't override `Department.generate_private_credential` which will be used for the default of `Credential.private` instead." }, "auto_expiry": { "type": "number", "description": "Specifies the number of years from the issue date after which the credential will automatically expire. If the specified value is less than or equal to 0, it will be ignored." }, "signup_url": { "type": "string", "description": "This provides a direct path for credential viewers to enroll in your course." }, "signup_url_show": { "type": "boolean", "description": "Show or hide the sign up url. The supported values are `true`, `false` and `null`." }, "course_link_show": { "type": "boolean", "description": "This links the credential data record to your information about the credential on your website. The supported values are `true`, `false` and `null`." }, "organization_link_show": { "type": "boolean", "description": "Show or hide the link to your website homepage. The supported values are `true`, `false` and `null`." }, "allow_duplicate_credentials": { "type": "boolean", "description": "An email address can receive more than one credential. The supported values are `true` & `false`. Defaults to `false`." }, "skill_category_id": { "type": "number", "description": "ID of the skill category to associate with this group." }, "collections": { "description": "Full list of collections to associate to this group" }, "achievement_type": { "type": "string", "description": "The type of achievement, for example 'Award' or 'Certification'. The supported values are listed here https://www.imsglobal.org/spec/ob/v3p0#achievementtype-enumeration" }, "earning_criteria": { "type": "array", "description": "Optional list of criteria the recipient must satisfy to earn this credential. Each item creates a new criterion on the group.", "items": { "type": "object", "properties": { "kind": { "type": "string", "description": "Category of the criterion.", "enum": [ "achievement", "certificate", "competency", "completion", "course", "degree", "exam", "experience", "knowledge", "license", "participation", "reading", "skill", "specialization", "other" ] }, "text": { "type": "string", "description": "Human-readable description of the criterion. Supports a limited set of HTML tags: `` (with `href`, `title`, `target`, `rel`), ``, `
`, `
`, `
`, `
`, `
`, `
`, `
`, `