The Paradym connector lets your AI agent act in each user's Paradym account. Each user connects their own Paradym API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 29 · 23 · 829 read23 write8 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Paradym connection
In AgentKit > Connections, create a Paradym connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'paradym'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Paradym:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'paradym_wallets_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "paradym"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Paradym:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="paradym_wallets_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Paradym credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolparadym_anoncreds_template_getGet one AnonCreds credential template by ID.Read-onlyGet AnonCreds Template
Get one AnonCreds credential template by ID. Returns archivedAt, updatedAt, createdAt, attributes, definition, schema, name, issuer, description, revocable. Use paradym_anoncreds_templates_list to find the ID.
Inputs
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_anoncreds_templates_listList the AnonCreds credential templates in a wallet (used with DIDComm).Read-onlyList AnonCreds Templates
List the AnonCreds credential templates in a wallet (used with DIDComm). Returns data (a list of records with archivedAt, updatedAt, createdAt, attributes, definition, schema, name, issuer, description, revocable). Use this to find a template ID for DIDComm issuance.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_archivedboolean- true returns only archived templates. Without it, archived templates are left out. Example: true
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_revocableboolean- Only return results whose revocable is this value. Example: true
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
search_namestring- Only return results whose name contains this value, ignoring case. Example: Employee
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_common_trusted_entities_listList the common trusted entities Paradym provides to every wallet.Read-onlyList Common Trusted Entities
List the common trusted entities Paradym provides to every wallet. Returns data (a list of records with etsiLotes, certificates, dids, description, name, updatedAt, createdAt, id). Use paradym_trusted_entities_list for the wallet's own entries.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
search_namestring- Only return results whose name contains this value, ignoring case. Example: Employee
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: createdAt, -createdAt, updatedAt, -updatedAt, id, -id. Example: createdAtone of
createdAt-createdAtupdatedAt-updatedAtid-id
paradym_didcomm_connection_getGet one DIDComm connection by ID.Read-onlyGet DIDComm Connection
Get one DIDComm connection by ID. Returns id, displayName, logoUrl, ourDid, theirDid, createdAt, updatedAt. Use paradym_didcomm_connections_list to find the ID.
Inputs
didcomm_connection_idstringrequired- The id of the DIDComm connection. Example: clu921ps300047eghxvhz33mb
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_didcomm_connections_listList DIDComm connections of a wallet.Read-onlyList DIDComm Connections
List DIDComm connections of a wallet. Returns data (a list of records with id, displayName, logoUrl, ourDid, theirDid, createdAt, updatedAt). Use this to find a connection ID for messaging, issuance or verification.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_didcomm_invitation_idstring- Only return results whose didcommInvitationId is this value. Example: example
filter_display_namestring- Only return results whose displayName is this value. Example: Example name
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
search_display_namestring- Only return results whose displayName contains this value, ignoring case. Example: Example name
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_didcomm_invitation_getGet one DIDComm invitation, including its invitation URL.Read-onlyGet DIDComm Invitation
Get one DIDComm invitation, including its invitation URL. Returns id, status, reusable, createdAt, updatedAt, expiresAt, did, invitationUri, invitationQrUri, invitationDeeplinkUri. Use paradym_didcomm_invitations_list to find the ID.
Inputs
didcomm_invitation_idstringrequired- The id of the DIDComm invitation. Example: clu921ps300047eghxvhz33mc
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_didcomm_invitations_listList DIDComm out-of-band invitations created by a wallet.Read-onlyList DIDComm Invitations
List DIDComm out-of-band invitations created by a wallet. Returns data (a list of records with id, status, reusable, createdAt, updatedAt, expiresAt, did, invitationUri, invitationQrUri, invitationDeeplinkUri). Use paradym_didcomm_invitation_create to make a new one.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_reusableboolean- Only return results whose reusable is this value. Example: true
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_didcomm_issuance_getGet one DIDComm issuance session and its status.Read-onlyGet DIDComm Issuance
Get one DIDComm issuance session and its status. Returns id, status, credential, error, didcommInvitationId, didcommConnectionId, createdAt, updatedAt, expiresAt. Poll this after creating an offer.
Inputs
didcomm_issuance_idstringrequired- The id of the DIDComm issuance session. Example: clu921ps300047eghxvhz33me
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_didcomm_issuances_listList DIDComm issuance sessions.Read-onlyList DIDComm Issuances
List DIDComm issuance sessions. Returns data (a list of records with id, status, credential, error, didcommInvitationId, didcommConnectionId, createdAt, updatedAt, expiresAt). Use paradym_didcomm_issuance_get for one session.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_didcomm_connection_idstring- Only return sessions over the DIDComm connection with this id. null returns the sessions without one. Example: example
filter_didcomm_invitation_idstring- Only return sessions started from the DIDComm invitation with this id. null returns the sessions started over an existing connection. Example: example
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_statusstring- Only return results whose status is this value. Example: example
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_didcomm_verification_getGet one DIDComm verification session and its presented data.Read-onlyGet DIDComm Verification
Get one DIDComm verification session and its presented data. Returns id, credentials, status, error, didcommConnectionId, didcommInvitationId, presentationTemplateId, createdAt, updatedAt, expiresAt. Poll this after creating a request.
Inputs
didcomm_verification_idstringrequired- The id of the DIDComm verification session. Example: clu921ps300047eghxvhz33md
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_didcomm_verifications_listList DIDComm verification sessions.Read-onlyList DIDComm Verifications
List DIDComm verification sessions. Returns data (a list of records with id, credentials, status, error, didcommConnectionId, didcommInvitationId, presentationTemplateId, createdAt, updatedAt, expiresAt). Use paradym_didcomm_verification_get for one session's result.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_didcomm_connection_idstring- Only return sessions over the DIDComm connection with this id. null returns the sessions without one. Example: example
filter_didcomm_invitation_idstring- Only return sessions started from the DIDComm invitation with this id. null returns the sessions started over an existing connection. Example: example
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_presentation_template_idstring- Only return results whose presentationTemplateId is this value. Example: example
filter_statusstring- Only return results whose status is this value. Example: example
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_dids_listList the DIDs owned by a wallet, filtered by DID, method or network.Read-onlyList DIDs
List the DIDs owned by a wallet, filtered by DID, method or network. Returns data (a list of records with id, did, network, method, createdAt, updatedAt). Use paradym_wallets_list to get the wallet ID.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_didstring- Only return results whose did is this value. Example: example
filter_methodstring- Only return results whose method is this value. Example: example
filter_networkstring- Only return results whose network is this value. Example: example
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
search_didstring- Only return results whose did contains this value, ignoring case. Example: example
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: createdAt, -createdAt, updatedAt, -updatedAt, -id, id. Example: createdAtone of
createdAt-createdAtupdatedAt-updatedAt-idid
paradym_issued_credentials_listList credentials issued from a wallet, filtered by format, status, template or exchange.Read-onlyList Issued Credentials
List credentials issued from a wallet, filtered by format, status, template or exchange. Returns data (a list of records with id, credentialTemplateId, status, exchange, format, revocable). Use this to find credential IDs to revoke.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_credential_template_idstring- Only return results whose credentialTemplateId is this value. Example: example
filter_exchangestring- Only return credentials issued over this exchange protocol, openid4vc or didcomm. null returns the credentials issued directly. Example: example
filter_formatstring- Only return results whose format is this value. Example: example
filter_statusstring- Only return results whose status is this value. Example: example
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id. Example: idone of
id-id
paradym_mdoc_template_getGet one mDoc credential template by ID.Read-onlyGet mDoc Template
Get one mDoc credential template by ID. Returns keyAttestations, attributeProviderId, authorization, revocable, attributes, validUntil, text, background, type, localization. Use paradym_mdoc_templates_list to find the ID.
Inputs
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_mdoc_templates_listList the mDoc (ISO 18013-5) credential templates in a wallet.Read-onlyList mDoc Templates
List the mDoc (ISO 18013-5) credential templates in a wallet. Returns data (a list of records with keyAttestations, attributeProviderId, authorization, revocable, attributes, validUntil, text, background, type, localization). Use paradym_sd_jwt_vc_templates_list for SD-JWT VC templates.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_archivedboolean- true returns only archived templates. Without it, archived templates are left out. Example: true
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_typestring- Only return results whose type is this value. Example: example
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
search_namestring- Only return results whose name contains this value, ignoring case. Example: Employee
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_openid4vc_issuance_getGet one OpenID4VC issuance session and its status.Read-onlyGet OpenID4VC Issuance
Get one OpenID4VC issuance session and its status. Returns id, status, credentials, error, offerUri, offerQrUri, offerDeeplinkUri, offerDeeplinkQrUri, createdAt, updatedAt. Poll this after creating an offer.
Inputs
openid4vc_issuance_idstringrequired- The id of the OpenID4VC issuance session. Example: clu921ps300047eghxvhz33ma
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_openid4vc_issuances_listList OpenID4VC issuance sessions, filtered by status.Read-onlyList OpenID4VC Issuances
List OpenID4VC issuance sessions, filtered by status. Returns data (a list of records with id, status, credentials, error, offerUri, offerQrUri, offerDeeplinkUri, offerDeeplinkQrUri, createdAt, updatedAt). Use paradym_openid4vc_issuance_get for one session.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_statusstring- Only return results whose status is this value. Example: example
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_openid4vc_verification_getGet one OpenID4VC verification session, including its status and the presented data.Read-onlyGet OpenID4VC Verification
Get one OpenID4VC verification session, including its status and the presented data. Returns id, status, credentials, error, transactionData, presentationTemplateId, createdAt, updatedAt, expiresAt, createdVia. Poll this after creating a request until the status is verified or failed.
Inputs
openid4vc_verification_idstringrequired- The id of the OpenID4VC verification session. Example: clu921ps300047eghxvhz33m9
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_openid4vc_verifications_listList OpenID4VC verification sessions, filtered by status or presentation template.Read-onlyList OpenID4VC Verifications
List OpenID4VC verification sessions, filtered by status or presentation template. Returns data (a list of records with id, status, credentials, error, transactionData, presentationTemplateId, createdAt, updatedAt, expiresAt, createdVia). Use paradym_openid4vc_verification_get for one session's shared attributes.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_created_viastring- Only return results whose createdVia is this value. One of: api, oauthAuthorization. Example: apione of
apioauthAuthorization filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_presentation_template_idstring- Only return results whose presentationTemplateId is this value. Example: example
filter_statusstring- Only return results whose status is this value. Example: example
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_presentation_template_getGet one presentation template by ID.Read-onlyGet Presentation Template
Get one presentation template by ID. Returns updatedAt, createdAt, eudi, openId4Vc, transactions, credentials, verifier, description, name, id. Use paradym_presentation_templates_list to find the ID.
Inputs
presentation_template_idstringrequired- The id of the presentation template. Example: clu921ps300047eghxvhz33m6
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_presentation_templates_listList the presentation templates (what a verifier asks a holder to share) in a wallet.Read-onlyList Presentation Templates
List the presentation templates (what a verifier asks a holder to share) in a wallet. Returns data (a list of records with updatedAt, createdAt, eudi, openId4Vc, transactions, credentials, verifier, description, name, id). Use this to find the template ID for a verification request.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
search_namestring- Only return results whose name contains this value, ignoring case. Example: Employee
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_sd_jwt_vc_template_getGet one SD-JWT VC credential template by ID.Read-onlyGet SD-JWT VC Template
Get one SD-JWT VC credential template by ID. Returns keyAttestations, attributeProviderId, authorization, revocable, attributes, validUntil, validFrom, text, background, type. Use paradym_sd_jwt_vc_templates_list to find the ID.
Inputs
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_sd_jwt_vc_template_json_schema_getGet the JSON schema of the attributes an SD-JWT VC credential template expects.Read-onlyGet SD-JWT VC Template JSON Schema
Get the JSON schema of the attributes an SD-JWT VC credential template expects. Returns additionalProperties, required, properties, type, description, title, $id, $schema. Use this before issuing to see the attribute shape.
Inputs
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_sd_jwt_vc_templates_listList the SD-JWT VC credential templates in a wallet, optionally filtered by type, revocability or archived state.Read-onlyList SD-JWT VC Templates
List the SD-JWT VC credential templates in a wallet, optionally filtered by type, revocability or archived state. Returns data (a list of records with keyAttestations, attributeProviderId, authorization, revocable, attributes, validUntil, validFrom, text, background, type). Use this to find a credential template ID for issuance.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_archivedboolean- true returns only archived templates. Without it, archived templates are left out. Example: true
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_revocableboolean- Only return results whose revocable is this value. Example: true
filter_typestring- Only return results whose type is this value. Example: example
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
search_namestring- Only return results whose name contains this value, ignoring case. Example: Employee
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id, createdAt, -createdAt, updatedAt, -updatedAt. Example: idone of
id-idcreatedAt-createdAtupdatedAt-updatedAt
paradym_trusted_entities_listList the trusted entities (issuers or verifiers trusted by DID or certificate) configured in a wallet.Read-onlyList Trusted Entities
List the trusted entities (issuers or verifiers trusted by DID or certificate) configured in a wallet. Returns data (a list of records with etsiLotes, certificates, dids, name, updatedAt, createdAt, id). Use paradym_common_trusted_entities_list for Paradym's shared list.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_namestring- Only return results whose name is this value. Example: Example name
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
search_namestring- Only return results whose name contains this value, ignoring case. Example: Employee
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: createdAt, -createdAt, updatedAt, -updatedAt, -id, id. Example: createdAtone of
createdAt-createdAtupdatedAt-updatedAt-idid
paradym_trusted_entity_getGet one trusted entity by ID.Read-onlyGet Trusted Entity
Get one trusted entity by ID. Returns etsiLotes, certificates, dids, name, updatedAt, createdAt, id. Use paradym_trusted_entities_list to find the ID.
Inputs
trusted_entity_idstringrequired- The id of the trusted entity. Example: clu921ps300047eghxvhz33m7
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_wallet_members_listList the users who are members of a wallet.Read-onlyList Wallet Members
List the users who are members of a wallet. Returns data (a list of records with id, isOwner, user, wallet, createdAt, updatedAt). Use paradym_wallets_list to get the wallet ID.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: id, -id. Example: idone of
id-id
paradym_wallet_profile_getGet the wallet's default profile: display name, logo and localization shown to holders.Read-onlyGet Wallet Profile
Get the wallet's default profile: display name, logo and localization shown to holders. Returns localization, defaultLocale, openId4VciRedirectUri, openId4VcVersion, wallet, logo, displayName, id. Use paradym_wallets_list to get the wallet ID.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_wallets_listList the wallets (formerly projects) the API key's user can access, with search and paging.Read-onlyList Wallets
List the wallets (formerly projects) the API key's user can access, with search and paging. Returns data (a list of records with id, name, ownerId, verificationDataAccess, createdAt, updatedAt). Use this first to get the wallet ID every other Paradym tool needs.
Inputs
filter_idstring- Only return results whose id is this value. Example: clu921ps300047eghxvhz33m5
filter_namestring- Only return results whose name is this value. Example: Example name
page_afterstring- Cursor: return results after this record ID (from the previous page's meta.next link). Example: clu921ps300047eghxvhz33mf
page_beforestring- Cursor: return results before this record ID (from the previous page's meta.prev link). Example: clu921ps300047eghxvhz33mg
page_sizenumber- Number of results per page (JSON:API pagination). The response meta.page shows the default and maximum. Example: 25
search_namestring- Only return results whose name contains this value, ignoring case. Example: Employee
sortstring- Sort property; prefix with - for descending, e.g. -createdAt. One of: -id, id, -createdAt, createdAt, -updatedAt, updatedAt. Example: -idone of
-idid-createdAtcreatedAt-updatedAtupdatedAt
paradym_anoncreds_template_createCreate an AnonCreds credential template with attributes and an optional revocation setting.WriteCreate AnonCreds Template
Create an AnonCreds credential template with attributes and an optional revocation setting. Returns archivedAt, updatedAt, createdAt, attributes, definition, schema, name, issuer, description, revocable. Use with paradym_didcomm_issuance_offer_create.
Inputs
attributesobjectrequired- Attributes. Example: {"name": {"type": "string", "name": "Full name", "required": true}}
namestringrequired- Name. Example: Employee Badge
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
descriptionstring- Description. Example: Badge for Acme employees
issuerstring- DID method the wallet uses to sign credentials from this template. did:web is the usual choice; the did:cheqd options are deprecated. One of: did:web, did:webvh, did:cheqd:mainnet, did:cheqd:testnet. Example: did:webone of
did:webdid:webvhdid:cheqd:mainnetdid:cheqd:testnet revocableboolean- Revocable. Example: false
schemastring- Schema. Example: example
paradym_didcomm_basic_message_sendSend a text message to a DIDComm connection.WriteSend DIDComm Basic Message
Send a text message to a DIDComm connection. Returns didcommConnectionId, message, messageId, replyMessageId, sentTime. Get the connection ID from paradym_didcomm_connections_list.
Inputs
didcomm_connection_idstringrequired- Didcomm Connection ID. Example: clu921ps300047eghxvhz33mb
messagestringrequired- Message. Example: Hello from Paradym
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
reply_message_idstring- Optional, the message id to which this message is a reply (parentThreadId). Example: 12345
paradym_didcomm_connection_updateChange a DIDComm connection's display name.WriteUpdate DIDComm Connection
Change a DIDComm connection's display name. Returns id, displayName, logoUrl, ourDid, theirDid, createdAt, updatedAt. Use paradym_didcomm_connections_list to find the ID.
- Idempotent
Inputs
didcomm_connection_idstringrequired- The id of the DIDComm connection. Example: clu921ps300047eghxvhz33mb
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
display_namestring- Display name of the connection. If not provided the current value will be used. Example: Acme Verifier
paradym_didcomm_invitation_createCreate a DIDComm connection invitation (single-use or reusable) and return its URL.WriteCreate DIDComm Invitation
Create a DIDComm connection invitation (single-use or reusable) and return its URL. Returns id, status, reusable, createdAt, updatedAt, expiresAt, did, invitationUri, invitationQrUri, invitationDeeplinkUri. Share the URL as a QR code; the holder accepts it to connect.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
didstring- did to use for the DIDComm invitation. Only the did method and network has to provided (e.g. did:web). If no did is provided a new did:peer did will be used that is also used for the connection. If a did is provided the did will be used in the invitation and allows wallet to reuse connections and recognize the inviter based on the provided did. The created connection will always use a new did:peer did, so the did is only used for the invitation. One of: did:web. Example: did:webone of
did:web goalobject- Goal. Example: {"code": "aries.vc.verify", "description": "Verify your employee badge"}
reusableboolean- Whether the invitation is reusable (can be used multiple times). Example: false
paradym_didcomm_invitation_receiveAccept a DIDComm invitation from another agent to create a connection.WriteReceive DIDComm Invitation
Accept a DIDComm invitation from another agent to create a connection. Returns didcommConnection. Use paradym_didcomm_invitation_create to invite someone instead.
Inputs
didcomm_invitationstringrequired- The DIDComm invitation to receive. Can be either an invitation URL or the JSON payload of the invitation. Example: {"invitationUrl": "https://paradym.id/invitation?oob=eyJ..."}
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
display_namestring- Display name of the connection, if not provided the displayName as provided by the other party in the invitation will be used. Example: Acme Verifier
paradym_didcomm_issuance_offer_createOffer an AnonCreds credential over DIDComm, to an existing connection or as a new invitation.WriteCreate DIDComm Issuance Offer
Offer an AnonCreds credential over DIDComm, to an existing connection or as a new invitation. Returns didcommInvitation, didcommIssuance. Use paradym_openid4vc_issuance_offer_create for OpenID4VC wallets.
Inputs
credentialobjectrequired- Credential. Example: {"credentialTemplateId": "clu921ps300047eghxvhz33m5", "attributes": {"name": "Jane Doe"}}
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
didcomm_connection_idstring- Didcomm Connection ID. Example: clu921ps300047eghxvhz33mb
didcomm_invitationobject- properties about the didcomm invitation containing the offer. Will be ignored if didcommConnectionId is provided. Example: {"invitationUrl": "https://paradym.id/invitation?oob=eyJ..."}
goalobject- The goal will be included in the both the invitation and the offer. Example: {"code": "aries.vc.verify", "description": "Verify your employee badge"}
paradym_didcomm_verification_request_createRequest a presentation over DIDComm, to an existing connection or as a new invitation.WriteCreate DIDComm Verification Request
Request a presentation over DIDComm, to an existing connection or as a new invitation. Returns didcommVerification, didcommInvitation. Use paradym_openid4vc_verification_request_create for OpenID4VC wallets.
Inputs
presentation_template_idstringrequired- Presentation Template ID. Example: clu921ps300047eghxvhz33m6
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
didcomm_connection_idstring- Didcomm Connection ID. Example: clu921ps300047eghxvhz33mb
didcomm_invitationobject- Didcomm Invitation. Example: {"invitationUrl": "https://paradym.id/invitation?oob=eyJ..."}
goalobject- Goal. Example: {"code": "aries.vc.verify", "description": "Verify your employee badge"}
paradym_mdoc_template_createCreate an mDoc credential template with its doctype, attributes, issuer certificate and validity.WriteCreate mDoc Template
Create an mDoc credential template with its doctype, attributes, issuer certificate and validity. Returns keyAttestations, attributeProviderId, authorization, revocable, attributes, validUntil, text, background, type, localization. Needs an issuer configuration; see the Paradym mDoc docs.
Inputs
attributesobjectrequired- Attributes. Example: {"org.iso.18013.5.1": {"type": "object", "properties": {"given_name": {"type": "string", "name": "Given name", "required": true}}}}
issuerobjectrequired- Issuer signing configuration for mDoc credentials, as a JSON object; signer is certificate (an X.509 issuer certificate in the wallet) and keyType optionally picks the key type. Example: {"signer": "certificate"}
namestringrequired- Name. Example: Employee Badge
typestringrequired- Type. Example: org.iso.18013.5.1.mDL
valid_untilobjectrequired- Valid Until. Example: {"future": {"years": 1}}
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
attribute_provider_idstring- The ID of the Attribute Provider that will be used to populate data for this credential's attributes during issuance. Example: 12345
authorizationobject- The authorization mechanism used during the credential issuance flow. Example: {"type": "oauth2", "authorizationServerId": "clu921ps300047eghxvhz33mi", "scopes": ["employee"]}
backgroundobject- Background. Example: {"key": "value"}
descriptionstring- Description. Example: Badge for Acme employees
key_attestationsobject- Key attestation requirements. Presence of the object means key attestations are required. Requires at least one trusted wallet to be configured. Example: {"key": "value"}
localizationarray- Localization for the credential template name and description. An array of objects, each with a locale BCP47 language tag (e.g., "en", "nl-NL", "de-DE"), the translated name, and optionally the description. Locales must be unique. Example: [{"locale": "en", "name": "Employee Badge"}]
revocableboolean- Revocable. Example: false
textobject- Text. Example: {"key": "value"}
trusted_walletsarray- Trusted entity ids whose wallet-typed entries are allowed to receive this credential. Example: ["value"]
paradym_mdoc_template_updateReplace an mDoc credential template's name, attributes, display and validity.WriteUpdate mDoc Template
Replace an mDoc credential template's name, attributes, display and validity. Returns keyAttestations, attributeProviderId, authorization, revocable, attributes, validUntil, text, background, type, localization. Use paradym_mdoc_template_get first to keep existing values.
- Idempotent
Inputs
attributesobjectrequired- Attributes. Example: {"org.iso.18013.5.1": {"type": "object", "properties": {"given_name": {"type": "string", "name": "Given name", "required": true}}}}
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
namestringrequired- Name. Example: Employee Badge
valid_untilobjectrequired- Valid Until. Example: {"future": {"years": 1}}
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
attribute_provider_idstring- The ID of the Attribute Provider that will be used to populate data for this credential's attributes during issuance. Example: 12345
authorizationobject- The authorization mechanism used during the credential issuance flow. Example: {"type": "oauth2", "authorizationServerId": "clu921ps300047eghxvhz33mi", "scopes": ["employee"]}
backgroundobject- Background. Example: {"key": "value"}
descriptionstring- Description. Example: Badge for Acme employees
key_attestationsobject- Key attestation requirements. Presence of the object means key attestations are required. Requires at least one trusted wallet to be configured. Example: {"key": "value"}
localizationarray- Localization for the credential template name and description. An array of objects, each with a locale BCP47 language tag (e.g., "en", "nl-NL", "de-DE"), the translated name, and optionally the description. Locales must be unique. Example: [{"locale": "en", "name": "Employee Badge"}]
textobject- Text. Example: {"key": "value"}
trusted_walletsarray- Trusted entity ids whose wallet-typed entries are allowed to receive this credential. Example: ["value"]
paradym_openid4vc_issuance_offer_createCreate an OpenID4VC credential offer for one or more templates with attribute values; returns the offer URI for the holder's wallet.WriteCreate OpenID4VC Credential Offer
Create an OpenID4VC credential offer for one or more templates with attribute values; returns the offer URI for the holder's wallet. Returns id, status, credentials, error, offerUri, offerQrUri, offerDeeplinkUri, offerDeeplinkQrUri, createdAt, updatedAt. Use paradym_sd_jwt_vc_issue for direct issuance without a wallet app.
Inputs
credentialsarrayrequired- The credentials to be issued in this issuance offer. Example: [{"credentialTemplateId": "clu921ps300047eghxvhz33m5", "attributes": {"name": "Jane Doe"}}]
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
expiration_in_minutesnumber- The number of minutes after which the offer should expire. If not provided, the default expiration time will be used (15 minutes). Minimum allowed expiration time is 1 minute, and maximum allowed expiration time is 7 days (10080 minutes). Example: 60
paradym_openid4vc_verification_completeComplete a same-device OpenID4VC verification with the response code returned to your redirect URI.WriteComplete OpenID4VC Verification
Complete a same-device OpenID4VC verification with the response code returned to your redirect URI. Returns id, status, credentials, error, transactionData, presentationTemplateId, createdAt, updatedAt, expiresAt, createdVia. Use only for requests created with a redirect_uri.
Inputs
challengestringrequired- The original client-generated challenge that was passed when the verification session was created. Example: a1b2c3d4
openid4vc_verification_idstringrequired- The id of the OpenID4VC verification session. Example: clu921ps300047eghxvhz33m9
response_codestringrequired- The response_code read from the query of the redirect URI after the wallet redirected the user-agent back. Example: 4f2c9e
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_openid4vc_verification_request_createCreate an OpenID4VC verification request from a presentation template; returns the authorization request URI to show as a QR code or link.WriteCreate OpenID4VC Verification Request
Create an OpenID4VC verification request from a presentation template; returns the authorization request URI to show as a QR code or link. Returns id, status, credentials, error, transactionData, presentationTemplateId, createdAt, updatedAt, expiresAt, createdVia. Use paradym_openid4vc_verification_get to read the result.
Inputs
presentation_template_idstringrequired- Presentation Template ID. Example: clu921ps300047eghxvhz33m6
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
challengestring- > Experimental: this may still change before it is stable. Client-generated random value (at least 128 bits of entropy is recommended, unique per request) that binds the verification result to the device/session that created the request. The challenge MUST be generated by the client. It is never included in the redirect URI, so intercepting the redirect does not reveal it, and Paradym only stores a hash of it. Keep it with the browser session that created the request: your server passes it on when creating and completing the verification, but should not store or log it. Must be provided... Example: a1b2c3d4
expiration_in_minutesnumber- The number of minutes after which the verification session should expire. If not provided, the default expiration time will be used (15 minutes). Minimum allowed expiration time is 1 minute, and maximum allowed expiration time is 7 days (10080 minutes). Example: 60
redirect_uristring- > Experimental: this may still change before it is stable. Redirect URI that the wallet should send the user-agent to after the authorization response has been submitted. The redirect URI is included in both error and success responses and enables continuing the flow in the browser after the wallet redirects back. Paradym appends a response_code query parameter to this URI when the wallet redirects back. The response_code is a single-use, server-generated value bound to the specific authorization response. After the redirect, the result must be retrieved by calling the complete... Example: example
require_response_encryptionboolean- Whether to require the presentation response from the wallet to be encrypted. If enabled, the response_mode in the request will be set to direct_post.jwt. If not enabled, the response_mode in the request will be set to direct_post. It is recommended to always use response encryption. When requesting mDoc credentials with the legacy OpenID4VC version, response encryption is required according to ISO 18013-7, and thus requireResponseEncryption MUST be enabled. This is the default when requesting any mDoc credentials. Defaults to true when OpenID4VC V1 is used, and when a presentation... Example: true
transaction_dataarray- > Experimental: this may still change before it is stable. The transaction data for the transactions defined in the presentation template. Required when the template defines transactions: one entry per transaction, matched by type, with the values of the attributes declared by that transaction. On approval the holder signs a hash of each entry with the presented credential, binding the presentation to this exact transaction. A presentation that does not sign a hash of every entry does not verify. Only supported with OpenID4VC version v1. Example: [{"type": "payment", "attributes": {"amount": "10.00"}}]
paradym_presentation_template_createCreate a presentation template listing the credentials and attributes to request from a holder.WriteCreate Presentation Template
Create a presentation template listing the credentials and attributes to request from a holder. Returns updatedAt, createdAt, eudi, openId4Vc, transactions, credentials, verifier, description, name, id. Use paradym_openid4vc_verification_request_create to request it from a holder.
Inputs
credentialsarrayrequired- Credentials. Example: [{"format": "sd-jwt-vc", "type": "https://metadata.paradym.id/types/employee-badge", "attributes": {"name": {"type": "string"}}}]
namestringrequired- Name. Example: Employee Badge
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
descriptionstring- Description. Example: Badge for Acme employees
eudiobject- > Experimental: this may still change before it is stable. Your registration as a relying party in the EU Digital Identity Wallet ecosystem, sent to the wallet with every request created from this template. Only for templates requesting sd-jwt-vc or mdoc credentials, and requires the wallet to use OpenID4VC version v1. Example: {"key": "value"}
openid4vcobject- OpenID4VC specific options for this template. Does not affect DIDComm verification requests using the same template. Example: {"key": "value"}
transactionsarray- > Experimental: this may still change before it is stable. Transactions the holder must authorize when presenting credentials from this template. Each transaction is signed by one of the presented credentials listed in its credentialIds. Only supported with OpenID4VC version v1 and sd-jwt-vc signing credentials. Example: [{"type": "payment", "credentialIds": ["badge"], "attributes": {"amount": {"type": "string"}}}]
verifierstring- DID method the wallet uses to identify itself as the verifier. did:web is the usual choice; the did:cheqd options are deprecated. One of: did:web, did:webvh, did:cheqd:mainnet, did:cheqd:testnet. Example: did:webone of
did:webdid:webvhdid:cheqd:mainnetdid:cheqd:testnet
paradym_presentation_template_updateReplace a presentation template's name, verifier and requested credentials.WriteUpdate Presentation Template
Replace a presentation template's name, verifier and requested credentials. Returns updatedAt, createdAt, eudi, openId4Vc, transactions, credentials, verifier, description, name, id. Use paradym_presentation_template_get first to keep existing values.
- Idempotent
Inputs
credentialsarrayrequired- Credentials. Example: [{"format": "sd-jwt-vc", "type": "https://metadata.paradym.id/types/employee-badge", "attributes": {"name": {"type": "string"}}}]
namestringrequired- Name. Example: Employee Badge
presentation_template_idstringrequired- The id of the presentation template. Example: clu921ps300047eghxvhz33m6
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
descriptionstring- Description. Example: Badge for Acme employees
eudiobject- > Experimental: this may still change before it is stable. Your registration as a relying party in the EU Digital Identity Wallet ecosystem, sent to the wallet with every request created from this template. Only for templates requesting sd-jwt-vc or mdoc credentials, and requires the wallet to use OpenID4VC version v1. Example: {"key": "value"}
openid4vcobject- OpenID4VC specific options for this template. Does not affect DIDComm verification requests using the same template. Example: {"key": "value"}
transactionsarray- > Experimental: this may still change before it is stable. Transactions the holder must authorize when presenting credentials from this template. Each transaction is signed by one of the presented credentials listed in its credentialIds. Only supported with OpenID4VC version v1 and sd-jwt-vc signing credentials. Example: [{"type": "payment", "credentialIds": ["badge"], "attributes": {"amount": {"type": "string"}}}]
verifierstring- DID method the wallet uses to identify itself as the verifier. did:web is the usual choice; the did:cheqd options are deprecated. One of: did:web, did:webvh, did:cheqd:mainnet, did:cheqd:testnet. Example: did:webone of
did:webdid:webvhdid:cheqd:mainnetdid:cheqd:testnet
paradym_sd_jwt_vc_issueIssue an SD-JWT VC directly and return the signed credential, without an OpenID4VC exchange.WriteIssue SD-JWT VC Directly
Issue an SD-JWT VC directly and return the signed credential, without an OpenID4VC exchange. Returns sdJwtVc, credential. Use paradym_openid4vc_issuance_offer_create to deliver to a holder's wallet app instead.
Inputs
credentialobjectrequired- Credential. Example: {"credentialTemplateId": "clu921ps300047eghxvhz33m5", "attributes": {"name": "Jane Doe"}}
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_sd_jwt_vc_template_createCreate an SD-JWT VC credential template: its type, name, attributes, display and validity.WriteCreate SD-JWT VC Template
Create an SD-JWT VC credential template: its type, name, attributes, display and validity. Returns keyAttestations, attributeProviderId, authorization, revocable, attributes, validUntil, validFrom, text, background, type. Use paradym_mdoc_template_create for mDoc credentials.
Inputs
attributesobjectrequired- Attributes. Example: {"name": {"type": "string", "name": "Full name", "required": true}}
namestringrequired- Name. Example: Employee Badge
typestringrequired- Type. Example: https://metadata.paradym.id/types/employee-badge
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
attribute_provider_idstring- The ID of the Attribute Provider that will be used to populate data for this credential's attributes during issuance. Example: 12345
authorizationobject- The authorization mechanism used during the credential issuance flow. Example: {"type": "oauth2", "authorizationServerId": "clu921ps300047eghxvhz33mi", "scopes": ["employee"]}
backgroundobject- Background. Example: {"key": "value"}
descriptionstring- Description. Example: Badge for Acme employees
issuerstring- DID method the wallet uses to sign credentials from this template. did:web is the usual choice; the did:cheqd options are deprecated. One of: did:web, did:webvh, did:cheqd:mainnet, did:cheqd:testnet. Example: did:webone of
did:webdid:webvhdid:cheqd:mainnetdid:cheqd:testnet key_attestationsobject- Key attestation requirements. Presence of the object means key attestations are required. Requires at least one trusted wallet to be configured. Example: {"key": "value"}
localizationarray- Localization for the credential template name and description. An array of objects, each with a locale BCP47 language tag (e.g., "en", "nl-NL", "de-DE"), the translated name, and optionally the description. Locales must be unique. Example: [{"locale": "en", "name": "Employee Badge"}]
revocableboolean- Revocable. Example: false
textobject- Text. Example: {"key": "value"}
trusted_walletsarray- Trusted entity ids whose wallet-typed entries are allowed to receive this credential. Example: ["value"]
valid_fromstring- Valid From. Example: example
valid_untilstring- Valid Until. Example: {"future": {"years": 1}}
paradym_sd_jwt_vc_template_unarchiveRestore an archived SD-JWT VC credential template.WriteUnarchive SD-JWT VC Template
Restore an archived SD-JWT VC credential template. List archived templates with paradym_sd_jwt_vc_templates_list and filter_archived true.
- Idempotent
Inputs
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_sd_jwt_vc_template_updateReplace an SD-JWT VC credential template's name, attributes, display and validity (the type cannot change).WriteUpdate SD-JWT VC Template
Replace an SD-JWT VC credential template's name, attributes, display and validity (the type cannot change). Returns keyAttestations, attributeProviderId, authorization, revocable, attributes, validUntil, validFrom, text, background, type. Use paradym_sd_jwt_vc_template_get first to keep existing values.
- Idempotent
Inputs
attributesobjectrequired- Attributes. Example: {"name": {"type": "string", "name": "Full name", "required": true}}
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
namestringrequired- Name. Example: Employee Badge
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
attribute_provider_idstring- The ID of the Attribute Provider that will be used to populate data for this credential's attributes during issuance. Example: 12345
authorizationobject- The authorization mechanism used during the credential issuance flow. Example: {"type": "oauth2", "authorizationServerId": "clu921ps300047eghxvhz33mi", "scopes": ["employee"]}
backgroundobject- Background. Example: {"key": "value"}
descriptionstring- Description. Example: Badge for Acme employees
key_attestationsobject- Key attestation requirements. Presence of the object means key attestations are required. Requires at least one trusted wallet to be configured. Example: {"key": "value"}
localizationarray- Localization for the credential template name and description. An array of objects, each with a locale BCP47 language tag (e.g., "en", "nl-NL", "de-DE"), the translated name, and optionally the description. Locales must be unique. Example: [{"locale": "en", "name": "Employee Badge"}]
textobject- Text. Example: {"key": "value"}
trusted_walletsarray- Trusted entity ids whose wallet-typed entries are allowed to receive this credential. Example: ["value"]
valid_fromstring- Valid From. Example: example
valid_untilstring- Valid Until. Example: {"future": {"years": 1}}
paradym_trusted_entity_createCreate a trusted entity from DIDs, X.509 certificates or ETSI trusted lists.WriteCreate Trusted Entity
Create a trusted entity from DIDs, X.509 certificates or ETSI trusted lists. Returns etsiLotes, certificates, dids, name, updatedAt, createdAt, id. Reference it from presentation templates to restrict accepted issuers.
Inputs
namestringrequired- Name of the trusted entity. This helps with identifying the trusted entity. Example: Employee Badge
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
certificatesarray- Trusted X509 certificates from this trusted entity. This doesn't have to be the certificate that is used for signing, but can be a root or intermediate certificate. At most 20 X509 certificates can be added to a trusted entity. The X509 certificate must be linked to a key of type RSA, P-256, P-384, P-521, Ed25519, secp256k1, or X25519. Example: [{"certificate": "MIIBszCCAVmgAwIBAgIU...", "name": "Acme issuer CA"}]
didsarray- Trusted Decentralized Identifiers (DIDs) from this trusted entity. At most 20 DIDs can be added to a trusted entity. DIDs must start with did:web, did:cheqd:testnet or did:cheqd:mainnet. Example: [{"did": "did:web:example.com"}]
etsi_lotesarray- > Experimental: this may still change before it is stable. Trusted EUDI Lists of Trusted Entities (ETSI LoTEs) from this trusted entity. At most 20 ETSI LoTEs can be added to a trusted entity. The type (issuer/wallet) of a LoTE is detected automatically from its LoTE profile and cannot be overridden; providing a type that conflicts with the detected one is rejected. Example: [{"url": "https://example.com/trusted-list.xml", "certificate": "MIIBszCCAVmgAwIBAgIU..."}]
paradym_trusted_entity_updateReplace a trusted entity's name, DIDs, certificates and trusted lists.WriteUpdate Trusted Entity
Replace a trusted entity's name, DIDs, certificates and trusted lists. Returns etsiLotes, certificates, dids, name, updatedAt, createdAt, id. Use paradym_trusted_entity_get first; omitted lists are cleared.
- Idempotent
Inputs
namestringrequired- Name of the trusted entity. This helps with identifying the trusted entity. Example: Employee Badge
trusted_entity_idstringrequired- The id of the trusted entity. Example: clu921ps300047eghxvhz33m7
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
certificatesarray- Trusted X509 certificates from this trusted entity. This doesn't have to be the certificate that is used for signing, but can be a root or intermediate certificate. At most 20 X509 certificates can be added to a trusted entity. The X509 certificate must be linked to a key of type RSA, P-256, P-384, P-521, Ed25519, secp256k1, or X25519. Example: [{"certificate": "MIIBszCCAVmgAwIBAgIU...", "name": "Acme issuer CA"}]
didsarray- Trusted Decentralized Identifiers (DIDs) from this trusted entity. At most 20 DIDs can be added to a trusted entity. DIDs must start with did:web, did:cheqd:testnet or did:cheqd:mainnet. Example: [{"did": "did:web:example.com"}]
etsi_lotesarray- > Experimental: this may still change before it is stable. Trusted EUDI Lists of Trusted Entities (ETSI LoTEs) from this trusted entity. At most 20 ETSI LoTEs can be added to a trusted entity. The type (issuer/wallet) of a LoTE is detected automatically from its LoTE profile and cannot be overridden; providing a type that conflicts with the detected one is rejected. Example: [{"url": "https://example.com/trusted-list.xml", "certificate": "MIIBszCCAVmgAwIBAgIU..."}]
paradym_wallet_createCreate a new wallet (a workspace for templates, issuance and verification).WriteCreate Wallet
Create a new wallet (a workspace for templates, issuance and verification). Returns id, name, ownerId, verificationDataAccess, createdAt, updatedAt. Use paradym_wallet_update to rename an existing wallet.
Inputs
namestringrequired- The name of the wallet. Example: Employee Badge
openid4vc_versionstring- The version of the OpenID for Verifiable Credentials specification suite to be used. The available options are: - v1 - version 1.0 of the OpenID for Verifiable Presentations and OpenID for Verifiable Credential Issuance specifications New wallets use version 1.0 of the specifications (v1). One of: v1. Example: v1one of
v1 verification_data_accessstring- The default data access configuration for verification sessions created through the OpenID4VC or DIDComm API. The available options are: - webhook - only emit verification data as webhook. The webhook is kept for at most 15 minutes, to retry it when your endpoint does not respond - once - only allow verification data to be retrieved once, with a limit of 15 minutes - 15min - only allow verification data to be retrieved for 15 minutes The default is to emit verification data as webhooks (webhook), as we recommend to handle it through webhooks. If you can't rely on webhooks, we recommend... One of: webhook, once, 15min. Example: webhookone of
webhookonce15min
paradym_wallet_profile_updateReplace the wallet's default profile (display name, logo, localization).WriteUpdate Wallet Profile
Replace the wallet's default profile (display name, logo, localization). Returns localization, defaultLocale, openId4VciRedirectUri, openId4VcVersion, wallet, logo, displayName, id. Use paradym_wallet_profile_get first to see the current values.
- Idempotent
Inputs
display_namestringrequired- Display Name. Example: Acme Verifier
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
default_localestring- The default locale for metadata published in this wallet. This locale will be used for the primary name and description in templates, attributes, and the profile display name. If not defined, the default names and descriptions will be included without language identifier. The value must be a supported BCP47 language tag (e.g., "nl-NL", "de-DE"),. Example: afone of
afsqamarhy-AMaz-AZbn-BDeu-ESbebgmy-MMcazh-HKzh-CNzh-TWhrcs-CZda-DKnl-NLenen-AUen-CAen-USen-GBen-INen-SGen-ZAetfilfi-FIfr-CAfr-FRgl-ESka-GEde-DEel-GRguiw-ILhi-INhu-HUis-ISidit-ITja-JPkn-INkkkm-KHko-KRky-KGlo-LAlvltmk-MKms-MYmsml-INmr-INmn-MNne-NPno-NOfafa-AEfa-AFfa-IRpl-PLpt-BRpt-PTparormru-RUsrsi-LKsksles-419es-ESes-USswsv-SEta-INte-INthtr-TRukurvi localizationarray- Localization for the profile display name. An array of objects, each with a locale BCP47 language tag (e.g., "nl-NL", "de-DE") and the translated name. Locales must be unique. Example: [{"locale": "en", "name": "Employee Badge"}]
logoobject- Logo. Example: {"url": "https://example.com/logo.png", "altText": "Acme logo"}
openid4vc_versionstring- The version of the OpenID for Verifiable Credentials specification suite to be used. Upgrading from 'legacy' to 'v1' is a one-way operation and cannot be reverted. See wallet documentation for more details. One of: v1, legacy. Example: v1one of
v1legacy walletobject- Configure the wallet that should be used for this profile. If not configured, the Paradym Wallet will be used by default. This influences the content that is displayed on the invitation page. Not available on the free tier. Example: {"name": "Acme Wallet", "baseUrl": "https://wallet.acme.example"}
paradym_wallet_updateUpdate a wallet's name or verification data access setting.WriteUpdate Wallet
Update a wallet's name or verification data access setting. Returns id, name, ownerId, verificationDataAccess, createdAt, updatedAt. Use paradym_wallets_list to get the wallet ID.
Inputs
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
namestring- The name of the wallet. Example: Employee Badge
verification_data_accessstring- The default data access configuration for verification sessions created through the OpenID4VC or DIDComm API. The available options are: - webhook - only emit verification data as webhook. The webhook is kept for at most 15 minutes, to retry it when your endpoint does not respond - once - only allow verification data to be retrieved once, with a limit of 15 minutes - 15min - only allow verification data to be retrieved for 15 minutes The default is to emit verification data as webhooks (webhook), as we recommend to handle it through webhooks. If you can't rely on webhooks, we recommend... One of: webhook, once, 15min, 1week, indefinite. Example: webhookone of
webhookonce15min1weekindefinite
paradym_anoncreds_template_archiveArchive an AnonCreds credential template.DestructiveArchive AnonCreds Template
Archive an AnonCreds credential template. Use paradym_anoncreds_templates_list to find the ID.
- Idempotent
Inputs
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_credentials_revokeRevoke one or more issued credentials, optionally notifying the holder wallet.DestructiveRevoke Credentials
Revoke one or more issued credentials, optionally notifying the holder wallet. Returns revokedCredentials. Get issued credential IDs from paradym_issued_credentials_list. Only revocable templates can be revoked.
Inputs
issued_credential_idsarrayrequired- Issued Credential IDs. Example: ["clu921ps300047eghxvhz33mh"]
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
notify_walletboolean- Whether to notify the wallet that a credential has been revoked. When multiple credentials are revoked within a batch for the same wallet, the wallet will receive a separate notification for each revoked credential. NOTE: this is only supported for Anoncreds credentials issued over Didcomm that have a DidcommConnection linked to it (so not for connectionless issuance). This option will be ignored for unsupported formats, or if no DidcommConnection is linked to the issued credential. The wallet is notified based on the Didcomm Revocation Notification V2 protocol. Example: false
paradym_didcomm_connection_deleteDelete a DIDComm connection.DestructiveDelete DIDComm Connection
Delete a DIDComm connection. Use paradym_didcomm_connections_list to find the ID.
- Idempotent
Inputs
didcomm_connection_idstringrequired- The id of the DIDComm connection. Example: clu921ps300047eghxvhz33mb
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_didcomm_invitation_deleteDelete a DIDComm invitation so it can no longer be accepted.DestructiveDelete DIDComm Invitation
Delete a DIDComm invitation so it can no longer be accepted. Use paradym_didcomm_invitations_list to find the ID.
- Idempotent
Inputs
didcomm_invitation_idstringrequired- The id of the DIDComm invitation. Example: clu921ps300047eghxvhz33mc
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_mdoc_template_archiveArchive an mDoc credential template so it can no longer be used to issue.DestructiveArchive mDoc Template
Archive an mDoc credential template so it can no longer be used to issue. Archived templates stay listed with filter_archived true.
- Idempotent
Inputs
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_presentation_template_archiveArchive a presentation template so it can no longer be used for new requests.DestructiveArchive Presentation Template
Archive a presentation template so it can no longer be used for new requests. Use paradym_presentation_templates_list to find the ID.
- Idempotent
Inputs
presentation_template_idstringrequired- The id of the presentation template. Example: clu921ps300047eghxvhz33m6
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_sd_jwt_vc_template_archiveArchive an SD-JWT VC credential template so it can no longer be used to issue.DestructiveArchive SD-JWT VC Template
Archive an SD-JWT VC credential template so it can no longer be used to issue. Use paradym_sd_jwt_vc_template_unarchive to restore it.
- Idempotent
Inputs
credential_template_idstringrequired- The id of the credential template. Example: clu921ps300047eghxvhz33m5
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
paradym_trusted_entity_deleteDelete a trusted entity from the wallet.DestructiveDelete Trusted Entity
Delete a trusted entity from the wallet. Use paradym_trusted_entities_list to find the ID.
- Idempotent
Inputs
trusted_entity_idstringrequired- The id of the trusted entity. Example: clu921ps300047eghxvhz33m7
wallet_idstringrequired- ID of the Paradym wallet (formerly called project) to act on. List wallets with paradym_wallets_list. Example: clu921ps300047eghxvhz33m4
No tools match.