Skip to content
Changelog

Report a bug

Paradym integration: operations for AI agents

Paradym connects to Type.com as an integration. This page lists the 102 operations documented for Claude and Codex in Type.com: 45 read, 32 write, 25 destructive.

About Paradym

Paradym is an API-first platform that simplifies the issuance, verification, and management of verifiable credentials, supporting standards like SD-JWT VCs over OpenID4VC and AnonCreds over DIDComm.

Categories: Security & Identity

How to connect Paradym to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

102 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

102 operations listed.

Webhooks

  • Read

    Retrieve webhooks

    Retrieve all webhooks associated associated with the provided walletId. Example An example query that searches for all webhooks where the name includes "Example" and order them by the date they were created descending, limiting the page size to 10 /v1/wallets/{walletId}/webhooks?

  • Read

    Retrieve webhook

    Retrieve a single webhook by its ID. The signature secret is only returned when the webhook is created, so it is not included here.

  • Write

    Create new webhook

    Create a new webhook for the given wallet. The webhook will be used to send notifications to the given URL. The URL must be reachable from the internet. We will send a request to the given URL to verify that it's reachable. When it's created you will get a signatureSecret.

  • Write

    Update webhook

    Update an existing webhook by ID. Only the name and eventTypes can be changed. The URL is immutable. Provide at least one of name or eventTypes. The signature secret is unchanged.

  • Destructive

    Replace webhook

    Replace an existing webhook by ID. Both name and eventTypes must be provided; they fully replace the current values. The URL is immutable and the signature secret is unchanged. Use PATCH to change only some fields.

  • Destructive

    Delete webhook

    Delete a webhook by ID.

Wallets

  • Read

    Retrieve wallets

    Retrieve all wallets for the user associated with the API key being used for the request.

  • Read

    Retrieve wallet members

    Retrieve all members associated with the provided walletId. Example An example query that searches for all members where in wallet, limiting the page size to 10 /v1/wallets/{walletId}/members?page[size]=10 Query parameters We are using the JSON:API 1.1 specification for requesti…

  • Write

    Create new wallet

    Creates a new wallet under the user which is associated with the API key being used for the request. The user will be the owner of the wallet. Creating multiple wallets is not available in the Free tier.

  • Write

    Updates a wallet

    Updates a wallet by only replacing the provided settings.

  • Write

    Add member to wallet

    Add a member to the provided wallet by email. Beware that the user will not be added until they have accepted the invitation. If an invitation is already active, you cannot add them again until the invitation has expired.

  • Destructive

    Updates a wallet

    Updates a wallet by fully replacing the current settings.

  • Destructive

    Remove member from wallet

    Remove a member from the provided wallet by email. If the user is not part of the wallet yet, but an invitation has already been sent, the invitation will be revoked, and the user won't be able to accept the invitation anymore.

Wallet Profile

  • Read

    Retrieve default profile

    Retrieves the default profile of the wallet. The wallet profile contains which version of the OpenID for Verifiable Credentials specification suite to use, and the public information about the wallet for display purposes.

  • Destructive

    Update default profile

    Updates the default profile of the profile. Upgrading from the OpenID4VC version from 'legacy' to 'v1' is a one-way operation, and cannot be reverted.

Trusted Entities

  • Read

    Retrieve trusted entities

    Retrieve all trusted entities associated with the provided walletId.

  • Read

    Retrieve trusted entity

    Retrieve a specific trusted entity by its id.

  • Write

    Create trusted entity

    Create a trusted entity. At least one DID or certificate MUST be provided. For both dids and certificates, at most 20 entries can be provided.

  • Destructive

    Update trusted entity

    Update a trusted entity. The same rules as creating a trusted entity apply. This will replace the entire trusted entity (including DIDs and certificates) with a new one.

  • Destructive

    Delete a trusted entity

    Delete a trusted entity by its id. NOTE: If the trusted entity is referenced in any presentation template it is not possible to remove the entity. First, remove the trusted entity from all presentation templates that reference this trusted entity.

SD JWT VC Credential Templates

  • Read

    Retrieve sd-jwt-vc credential templates

    Retrieve all sd-jwt-vc credential templates associated with the provided walletId.

  • Read

    Retrieve sd-jwt-vc credential template

    Retrieve a specific sd-jwt-vc credential template by its id. This endpoint supports the following query parameters: - include - Include a relation model in the response.

  • Read

    Retrieve JSON schema for sd-jwt-vc credential template

    Get the JSON schema for an sd-jwt-vc credential template. You could use this for to generate forms or validate the input.

  • Read

    Retrieve SD-JWT VC type metadata for sd-jwt-vc credential template

    Get the SD-JWT VC type metadata for an sd-jwt-vc credential template. The typeMetadata object is the document described by the SD-JWT VC Type Metadata documentation.

  • Write

    Create sd-jwt-vc credential template

    Create a new sd-jwt-vc credential template. When issuing with a certificate, some limitations apply: - The validFrom field is not allowed to be set. The credential will always be valid from the moment it is issued.

  • Write

    Unarchive sd-jwt-vc credential template

    Unarchive a specific sd-jwt-vc credential template by its id.

  • Destructive

    Update sd-jwt-vc credential template

    Update a specific sd-jwt-vc credential template by its id. This will replace the entire template with the new one, except for the type and issuer fields (these can't be updated) Type Metadata Updating a template also updates the SD-JWT VC Type Metadata document that wallets and…

  • Destructive

    Archive sd-jwt-vc credential template

    Archive a specific sd-jwt-vc credential template by its id.

Revocation

  • Write

    Batch revoke credentials

    Revoke a batch of credentials based on the issued credential id. Only credentials issued based on a template where revocable is true can be revoked. Credentials that have already been revoked cannot be revoked again.

Presentation Templates

  • Read

    Retrieve presentation templates

    Retrieve all presentation templates associated with the provided walletId.

  • Read

    Retrieve presentation template

    Retrieve a specific presentation template by its id. This endpoint supports the following query parameters: - include - Include a relation model in the response.

  • Write

    Create presentation template

    Create a new presentation template. A presentation template can either request: - AnonCreds credentials, to be used with DIDComm Verification. - Mdoc and SD JWT VC credentials, to be used with OpenID4VC Verification

  • Destructive

    Update presentation template

    Update a specific presentation template. This will replace the entire template with the new one.

  • Destructive

    Archive presentation template

    Archive a specific presentation template by its id.

Open ID4VC Verification

  • Read

    Retrieve OpenID4VC verification sessions

    Retrieve all OpenID4VC verification sessions associated with the provided walletId.

  • Read

    Retrieve OpenID4VC verification session

    Retrieve a specific OpenID4VC verification session by its id.

  • Write

    Create OpenID4VC verification request

    Create an OpenID4VC verification request for the selected presentation template. See the API execution part of the Verify Credentials guide for more information.

Open ID4VC Issuance

  • Read

    Retrieve OpenID4VC issuance sessions

    Retrieve all OpenID4VC issuance sessions associated with the provided walletId.

  • Read

    Retrieve OpenID4VC issuance session

    Retrieve a specific OpenID4VC issuance session by its id.

  • Write

    Create OpenID4VC credential offer

    Create a OpenID4VC issuance offer for the selected credentials See the API execution part of the Issue Credential guide for more information. The issuance session will automatically expire 7 minutes after it was created.

M Doc Credential Templates

  • Read

    Retrieve mdoc credential templates

    Retrieve all mdoc credential templates associated with the provided walletId.

  • Read

    Retrieve mdoc credential template

    Retrieve a specific mdoc credential template by its id. This endpoint supports the following query parameters: - include - Include a relation model in the response.

  • Read

    Retrieve JSON schema for mdoc credential template

    Get the JSON schema for an mdoc credential template. You could use this for to generate forms or validate the input.

  • Write

    Create mdoc credential template

    Create a new mdoc credential template. The validUntil field must be set as a duration from the moment the credential is issued, and it must not exceed 365 days. Premium features - localization (template and attributes): Available on the Builder tier and up.

  • Write

    Unarchive mdoc credential template

    Unarchive a specific mdoc credential template by its id.

  • Destructive

    Update mdoc credential template

    Update a specific mdoc credential template by its id. This will replace the entire template with the new one, except for the type and issuer fields (these can't be updated) Premium features - localization (template and attributes): Available on the Builder tier and up.

  • Destructive

    Archive mdoc credential template

    Archive a specific mdoc credential template by its id.

Keys

  • Read

    Retrieve keys

    Retrieve the keys associated with the provided walletId, and, when a key's deletion has been arranged, when its material is expected to be gone. Destroyed keys are listed too, so a key does not silently vanish once it is gone.

  • Destructive

    Delete a key

    Delete a key ahead of the automatic clean-up. Keys are reclaimed on their own once the certificate they back is revoked or expired, so you rarely need this.

  • Destructive

    Cancel key deletion

    Cancel a scheduled deletion, putting the key back to work. Possible for the whole grace period, on every backend: where the backend has already been asked to destroy the key, Paradym restores it first, so success always means the key can sign again.

Key backends

  • Read

    Retrieve available key backends

    Retrieve the key backends that are available (enabled and configured) for this deployment. The software backend is always available. Externally-managed backends (e.g. Google Cloud KMS) are only returned when they are enabled and configured for the deployment.

Issued Credentials

  • Read

    Retrieve Issued Credentials

    Retrieve all issued credentials associated with the provided walletId.

Direct Issuance

  • Write

    Directly issue sd-jwt-vc

    Directly issue an sd-jwt-vc based on a SD-JWT VC Credential Template. Binding a directly issued credential to a holder DID is not supported yet when directly issuing, you can use OpenID4VC Issuance to bind an issued sd-jwt-vc to a holder DID.

DIDs

  • Read

    Retrieve DIDs

    Retrieve all DIDs associated with the provided walletId. Example An example query that searches for all dids where method is cheqd and order them by the date they were created descending, limiting the page size to 10 /v1/wallets/{walletId}/dids?filter[method]=cheqd&sort=-created…

DIDComm Connections

  • Read

    Retrieve DIDComm connections

    Retrieve all DIDComm connections associated with the provided walletId.

  • Read

    Retrieve DIDComm connection

    Retrieve a specific DIDComm connection by its id.

  • Write

    Update DIDComm connection

    Update a specific DIDComm connection by its id. You can only update the displayName.

  • Destructive

    Delete DIDComm connection

    Delete a specific DIDComm connection by its id.

DIDComm Invitations

  • Read

    Retrieve DIDComm invitations

    Retrieve all DIDComm invitations associated with the provided walletId.

  • Read

    Retrieve DIDComm invitation

    Retrieve a specific DIDComm invitation by its id.

  • Write

    Receive DIDComm invitation

    Receive a DIDComm invitation. Only https://didcomm.org/out-of-band invitations using handshakeprotocols including https://didcomm.org/didexchange/1.x (where x may be any version) are supported.

  • Write

    Create DIDComm connection invitation

    Create a DIDComm connection invitation. The invitation will be a https://didcomm.org/out-of-band invitation, leveraging https://didcomm.org/didexchange/1.x (where x may be any version) as the value for handshakeprotocols.

  • Destructive

    Delete DIDComm invitation

    Delete a specific DIDComm invitation by its id.

DIDComm Verification

  • Read

    Retrieve DIDComm verification sessions

    Retrieve all DIDComm verification sessions associated with the provided walletId.

  • Read

    Retrieve a DIDComm verification session by its ID.

    Retrieve a DIDComm verification session by its ID.

  • Write

    Create DIDComm verification request

    Create an DIDComm verification request for the selected presentation template. The request and invitation will automatically expire 30 days after it was created.

DIDComm Messaging

  • Write

    Send a basic message

    Send a basic message to an existing connection

  • Write

    Send a custom message

    Send a custom message to an existing connection. The following protocols are not allowed as @type, as they are natively supported by Paradym: - https://didcomm.org/connections - https://didcomm.org/didexchange - https://didcomm.org/issue-credential - https://didcomm.org/present-…

DIDComm Mediators

  • Read

    Retrieve mediators

    Get all the mediators for the current user. All of these you can use to allow certain public keys to connect to the mediator. We are using the JSON:API 1.1 specification for requesting a list of entities.

  • Read

    Retrieve mediator

    Get a specific DIDcomm mediator by its id.

  • Read

    Retrieve mediator connections

    This gives the possibility to fetch mediator connections. We are using the JSON:API 1.1 specification for requesting a list of entities. From this specification we support the following query parameters: - filter[ ] - Filter the results by the given property.

  • Read

    Retrieve mediator connection

    Get a specific mediator connection by its id.

  • Write

    Allow mediator connection based on public key

    Allow a mediator connection to be created based on a specific public key. When the wallet tries to connect with the mediator it will be matched with the public key. After it's matched and the connection is created, the status of the mediator connection will become active.

  • Destructive

    Delete mediator connection

    Delete a mediator connection. If the connection has not been established yet, this will revoke the allowance for a mediator connection. If a connection has already been established, this will delete the conneciton and prevent the wallet from using the mediator going forward.

DIDComm Issuance

  • Read

    Retrieve DIDComm issuance sessions

    Retrieve all DIDComm issuance sessions associated with the provided walletId.

  • Read

    Retrieve DIDComm issuance session

    Retrieve a specific DIDComm issuance session by its id.

  • Write

    Create DIDComm issuance offer

    Create or send a DIDComm issuance offer for the provided credential. Only credential templates for the anoncreds format are currently supported for usage with DIDComm offers.

Certificate Signing Requests

  • Read

    Retrieve certificate signing requests

    Retrieve all certificate signing requests associated with the provided walletId.

  • Write

    Create certificate signing request

    Create a new certificate signing request based on the PKCS 10 specification. Creating externally signed certificates is not available in the Free tier. The returned certificate signing request is encoded as PEM.

  • Write

    Import certificate from request

    Import a certificate for a certificate signing request. Once a certificate signing request has been created, you can use this endpoint to import the signed certificate.

  • Destructive

    Delete certificate signing request

    Delete a certificate signing request.

Certificates

  • Read

    Retrieve certificates

    Retrieve all certificates associated with the provided walletId.

  • Write

    Create certificate

    Create a new certificate of a specific type. The following certificate types can be created: - verifierRoot - issuerRoot You can also import an externally signed issuerSignCredential or verifierSignRequest certificate using the Certificate Signing Request API.

  • Write

    Activate certificate

    Activates a certificate. The following certificate types can be activated: - verifierRoot - issuerRoot - externally signed issuerSignCredential - externally signed verifierSignRequest Note that certificates can only be activated if they are in the pendingActivation state.

  • Write

    Deactivate certificate

    Deactivates a certificate. The following certificate types can be deactivated: - verifierRoot - issuerRoot - issuerSignCredential - verifierSignRequest Deactivating a certificate will not invalidate any signatures created with this certificate.

  • Destructive

    Revoke certificate

    Revokes a certificate. The following certificate types can be revoked: - verifierRoot - verifierSignRequest - only if not externally signed - issuerRoot - issuerSignCredential - only if not externally signed Revoking a certificate will invalidate any signatures created with this…

Authorization Servers

  • Read

    Retrieve authorization servers

    Retrieve all authorization servers associated with the provided walletId.

  • Read

    Retrieve authorization server

    Retrieves an authorization server by its id.

  • Write

    Create a new authorization server

    Create a new authorization server.

  • Destructive

    Updates an authorization server

    Updates an authorization server.

  • Destructive

    Deletes an authorization server

    Deletes an authorization server. It is not possible to delete an authorization server that is referenced by any credential template. First, disconnect the authorization server from all relevant credential templates.

Attribute Providers

  • Read

    Retrieve attribute providers

    Retrieve all attribute providers associated with the provided walletId.

  • Read

    Retrieve attribute provider

    Retrieves an attribute provider by its id.

  • Write

    Create a new attribute provider

    Create a new attribute provider.

  • Destructive

    Updates an attribute provider

    Updates an attribute provider.

  • Destructive

    Deletes an attribute provider

    Deletes an attribute provider. It is not possible to delete an attribute provider that is referenced by any credential template. First, disconnect the attribute provider from all relevant credential templates.

Anoncreds Credential Templates

  • Read

    Retrieve anoncreds credential templates

    Retrieve all anoncreds credential templates associated with the provided walletId.

  • Read

    Retrieve anoncreds credential template

    Retrieve a specific anoncreds credential template by its id.

  • Read

    Retrieve JSON schema for anoncreds credential template

    Get the JSON schema for an anoncreds credential template. You could use this for to generate forms or validate the input.

  • Write

    Create anoncreds credential template

    Create a new anoncreds credential template If you provide an existing schema, the API will count a call to this endpoint as a single transaction.

  • Write

    Unarchive anoncreds credential template

    Unarchive an anoncreds credential template by its id.

  • Destructive

    Archive anoncreds credential template

    Archive an anoncreds credential template by its id.

See How connections work for access and permissions, or browse all integrations.