{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8f4ac97f-077e-41bd-a69b-a6d70f281f53","name":"Pilot Documentation","description":"**Version: 0.40** \n\nThis documentation explains for trading partners, credential issuers and verification routing service (VRS) providers how to interact with the APIs exposed by the Spherity Credentialing Service.\n\nSpecifically, this API documentation describes the API flows for credential issuer and verification routing service (VRS) providers. \n\n\n**Credential issuer:**\n\nTo issue the Identity Credential and ATP Credentials to trading partners, the credential issuer needs to integrate the following APIs:\n\n- Send offer to issue a credential\n- Send Presentation Request\n- Credentials - Revoke\n- Credentials - Verify Revocation Status\n\nThe following APIs are available and can be used by the credential issuer on request:\n- Credentials - GET\n- Credential RevocationList - Get\n- Threads - Get\n\nThe following APIs are required for the Wallet to Wallet communication, but automated by Spherity:\n- Send Credential Request (automated)\n- Send Credential (automated)\n- Save Credential (automated)\n\n**VRS provider:**\n\nThe VRS provider needs to integrate the following APIs in his PI Verification process:\n\n- Generate Signed Verifiable Presentation (JWT)\n- Verify Signed Verified Presentation (JWT)\n\nThe trading partner permits his VRS provider to have a restricted account to his enterprise identity wallets managed in the Spherity Credentialing Service. The restricted account enables the VRS provider to authenticate himself to use the APIs designed for the usage of ATP credentials in PI Verifications.\n\n**Trading Partners**\n\nEvery trading partner using the Spherity Credentialing Service has access to a web application:\nwith the following product features: \n\n- **Identity engine**: Create an enterprise identity and credentialize your FEI (FDA Establishment Identifier) or state license status\n- **VRS plug-in**: Activate or deactivate the restricted access of the VRS provider to interact with the two APIs to generate or verify ATP credentials \n- **Compliance dashboard**: Monitor and investigate every credential based PI Verification interaction, with full transparency over complete audit-trails.\n- **ATP Whitelist**: Manage verified trading partners\n\n**Integrated standards and further specifications**\n**Identifier**\n\nA DID is a globally unique identifier developed specifically for decentralized systems as defined by the W3C DID specification (https://w3c-ccg.github.io/did-spec/). DIDs enable interoperable decentralized Self-Sovereign Identity management. A DID is associated with exactly one DID Document.\n \n**Credential Structure**\n\nA Credential that includes a proof from its issuer. Typically this proof is in the form of a digital signature. Based on the definition provided by the W3C Verifiable Claims Working Group.\n \n**Credential Schemas**\n\nThe credential schema are documented here: https://github.com/Open-Credentialing-Initiative\n \n**Schemas**\nJSON Schemas for aforementioned credentials to be defined and anchored using GS1 Web Vocab\n \n**Signatures**\n\nThe proofs (including signatures) of Verifiable Credentials and Verifiable Presentation to be generated and verified in conformance with JSON Web Signature 2020 that is one of relevant LD Signature Suites to the date that are registered at Linked Data Cryptographic Suite Registry.\n \n**Verification Method**\n\n1. Signing and verification of Verifiable Credentials to be achieved using key pairs based on Secp256k1 curve. \n2. Public keys to be represented as JWK that is a supported format by DID Doc spec.\n3. Public keys to be referenced in a respective DID Document and associated with specific proof purposes via the \"Verification Relationship\" concept that is defined in DID Core spec for further verification.\n\n**Wallet to Wallet communication**\n\nWallet to wallet communication between Credential Issuer and Trading Partner Identity Wallet is based on a set of interoperable and DID method agnostic Aries RFCs that find its roots in working items of Decentralized Identity Foundation. This High Level chart can be used as guidance for the subject workflow.\n\nAll messages to be packed (signed/encrypted) in JWM envelopes using DIDComm v2 spec.\n\nAries RFCs (key ones)\n- Issue Credential Protocol v2\n- Credential Manifest\n- Present Proof Protocol v2\n- Presentation Exchange\n\nDecentralized Identity Foundation specs\n- DIDComm Messaging v2\n- Credential Manifest\n- Presentation Exchange\n \n**Messaging Standard for PI Verification**\n\nTo exchange verifiable presentations of VCs in form of a JSON Web Token, the VRS providers integrating the Spherity Credentialing Service are able attach the JWT to the header of the GS1 Lightweight Messaging Standard for PI Verifications.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11378415","team":1008858,"collectionId":"8f4ac97f-077e-41bd-a69b-a6d70f281f53","publishedId":"T17FAToR","public":true,"publicUrl":"https://documenter-api.postman.tech/view/11378415/T17FAToR","privateUrl":"https://go.postman.co/documentation/11378415-8f4ac97f-077e-41bd-a69b-a6d70f281f53","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-01-04T09:32:12.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"<ProductName> - <Stage> - <State> - <TenantName>","id":"0a39fc97-7dbd-4c93-91f4-b412adf95ade","owner":"11378415","values":[{"key":"TEMPLATE","value":"TEMPLATE","enabled":true},{"key":"-","value":"-","enabled":true},{"key":"REQURED","value":"VARIABLES","enabled":true},{"key":"=","value":"=","enabled":true},{"key":"WALLET_API_BASE_URL","value":"","enabled":true},{"key":"realmName","value":"","enabled":true},{"key":"defaultUsername","value":"","enabled":true},{"key":"defaultPassword","value":"","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/73b6a4e6646d1568530c27b9d91ab16aa3dccc19911ec8ed29ac79d4cf03eee5","favicon":"https://res.cloudinary.com/postman/image/upload/v1589966335/team/e5femmxak6lbsbddqfmg.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"<ProductName> - <Stage> - <State> - <TenantName>","value":"11378415-0a39fc97-7dbd-4c93-91f4-b412adf95ade"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/T17FAToR"}