parafe_discover | Fetch a target agent's agent card to learn its Parafe trust requirements |
parafe_register | Register a new agent identity (P-256 key by default, or Ed25519; JWT and SD-JWT VC credentials). Only type is required. With an API key, name is required (unique per operator); without one, name and principal_name are optional and shown only on the claim page. With an API key, acts_for_ref registers it for one of your platform's users (an opaque reference, not an email): you become its operator |
parafe_initiate_handshake | Start mutual authentication with a target agent |
parafe_complete_handshake | Complete a handshake initiated by another agent |
parafe_escalate_scope | Request additional scope within an existing session |
parafe_verify_consent | Check if an action is permitted by a consent token (and, with presentation_proof, that it's presented by its rightful holder) |
parafe_record_action_receipt | Sign an action receipt for what you did or refused, and file it in the session's index |
parafe_file_action_receipt | File the other agent's action receipt (or an AP2 receipt) in the session's index |
parafe_get_action_receipts | List the session's index (either participant) |
parafe_create_claim_link | A claim link for an agent registered without an API key (or by a platform for one of its users): the person it acts for opens it, checks the code and approves while signed in to Parafé, and the agent acts for them |
parafe_get_claim_status | Whether the person has approved the claim link yet. Waits for the approval (up to wait_seconds, default 25) and answers the moment they approve; call it again while claimed is false, for up to 30 minutes. Then parafe_renew_credential. Needs @getparafe/sdk 0.12 and a broker from 2026-10-08 |
parafe_close_session | Close a session and generate a signed receipt |
parafe_get_session_receipt | Fetch a closed session's receipt (either participant) |
parafe_verify_receipt | Ask the broker to check a receipt's signature (for an independent check, verify the JWS against the broker's JWKS, e.g. with @getparafe/verify) |
parafe_revoke_agent | Revoke an agent identity |
parafe_renew_credential | Renew a credential: after a claim or a tier change, or when expired or within 7 days of expiry; otherwise renewed: false |
parafe_update_scope_policies | Update an agent's accepted scope policies |
parafe_get_public_key | Get the broker's signing keys (JWKS) |
parafe_verify_consent_locally | Verify a consent token offline against the broker's keys |
parafe_create_presentation_proof | Proof to send with a consent token you present (tokens are bound to your key) |
parafe_get_agent_metrics | Get reputation metrics for an agent (trust signals from interaction history). With an API key: your org's agents and agents with no org only (403 for another org's agent) |
parafe_verify_mandate | Have the broker verify an AP2 mandate presented to you (merchant or payment processor): valid, the AP2 error code if not, the agent holding it, the redemption |
parafe_record_ap2_receipt | Sign an AP2 Checkout or Payment Receipt and file it in the session's index (needs a P-256 agent key) |
parafe_sign_ap2_receipt | Sign an AP2 Checkout or Payment Receipt without filing it (a purchase outside a Parafé session) |