{ "opencollection": "1.0.0", "info": { "name": "Privado ID - Issuer Agent Credentials API", "version": "1" }, "items": [ { "info": { "name": "Credentials", "type": "folder" }, "items": [ { "info": { "name": "Get Credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/identities/:identifier/credentials", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Issuer identifier" }, { "name": "page", "value": "", "type": "query", "description": "Page to fetch. First is one. If omitted, all results will be returned." }, { "name": "credentialSubject", "value": "", "type": "query" }, { "name": "schemaType", "value": "", "type": "query", "description": "Filter credentials by schema type (partial match)" }, { "name": "schemaUrl", "value": "", "type": "query", "description": "Filter credentials by schema URL (begins with match)" }, { "name": "status", "value": "", "type": "query", "description": "Credential status:\n * `all` - All Credentials. (default value)\n * `revoked` - Only revoked credentials\n * `expired` - Only expired credentials\n" }, { "name": "query", "value": "", "type": "query", "description": "Query string to do full text search" }, { "name": "max_results", "value": "", "type": "query", "description": "Number of items to fetch on each page. Minimum is 10. Default is 50. No maximum by the moment." }, { "name": "sort", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of credentials for the provided identity. Results are paginated.\nFilter between all | revoked | expired credentials and also perform a full text search with the query parameter.\n" }, { "info": { "name": "Create Credential", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/identities/:identifier/credentials", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Issuer identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a credential for the provided identity." }, { "info": { "name": "Get Credential", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/identities/:identifier/credentials/:id", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Issuer identifier" }, { "name": "id", "value": "", "type": "path", "description": "Claim identifier" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a specific credential for the provided identity." }, { "info": { "name": "Delete Credential", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/identities/:identifier/credentials/:id", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Issuer identifier" }, { "name": "id", "value": "", "type": "path", "description": "Claim identifier" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Remove a specific credential for the provided identity." }, { "info": { "name": "Revoke Credential", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/identities/:identifier/credentials/revoke/:nonce", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Issuer identifier" }, { "name": "nonce", "value": "", "type": "path", "description": "Claim nonce" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Revokes a specific credential for the provided identity." }, { "info": { "name": "Get Revocation Status V1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/:identifier/claims/revocation/status/:nonce", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Issuer identifier" }, { "name": "nonce", "value": "", "type": "path", "description": "Claim nonce" } ] }, "docs": "Endpoint to get the revocation status" }, { "info": { "name": "Get Revocation Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/identities/:identifier/credentials/revocation/status/:nonce", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Issuer identifier" }, { "name": "nonce", "value": "", "type": "path", "description": "Claim nonce" } ] }, "docs": "Endpoint to get the revocation status" }, { "info": { "name": "Get Credentials Offer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/identities/:identifier/credentials/:id/offer", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Issuer identifier" }, { "name": "id", "value": "", "type": "path", "description": "Claim identifier" }, { "name": "type", "value": "", "type": "query", "description": "Type:\n * `universalLink` - (default value) Returns a universal link. The preferred and more standard way to access the offer message \n * `deepLink` - Returns a deeplink with a link redirection to the original message. \n * `raw` - Returns the raw offer message.\n" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a universal/deep link to an offer or raw offer message that can be used for accepting a claim. | Response can be in 3 formats `universalLink`, `deepLink` or `raw`. Default is `universalLink`. Raw is the raw QR code and link is a QR code with a link to the raw content. Regardless of the type, the field will always be called universalLink." } ] } ], "bundled": true }