Skip to content
Developer

WorkspaceDocsQuickstart

Quickstart

The documented identity, permission and authorization sequence for an external agent.

An authorized request is not a payment

WAYLOCK answers ALLOW, DENY or APPROVAL_REQUIRED and records approvals. Payment execution is not available yet, so nothing is sent to a payment provider.

Sequence

  1. 01Register the agentA person registers the agent in the operations or developer platform.registerAgent
  2. 02Create and activate a policyCreate a policy version, then activate it for the agent.createPolicyVersionactivatePolicyVersion
  3. 03Add a sourceA source is a record your permissions point to. It holds no money and links no account.registerSourceFinancialResource
  4. 04Create and activate a permissionCreate a permission with a ceiling and an approval threshold in USD minor units, then activate it.createPermissionactivatePermission
  5. 05Register the external agentRegister the external agent with the identity reference your platform uses.registerExternalAgent
  6. 06Verify the keyYour integration supplies its Ed25519 public key; WAYLOCK returns a challenge; your integration signs it and the person submits the response.createVerificationChallengeverifyExternalAgent
  7. 07PairA person issues a single-use pairing code. Your integration requests a redemption challenge, redeems the code with a signed proof and receives its agent credential.issuePairingArtifactcreatePairingRedemptionChallengeredeemPairingArtifact
  8. 08Activate the agentWith a current permission and an active credential, a person activates the agent.activateAgent
  9. 09Request authorizationYour integration requests authorization with its agent credential. The answer is ALLOW, DENY or APPROVAL_REQUIRED.createAuthorizationRequest

Requests

  • Every request that changes state carries an Idempotency-Key. Repeating a request with the same key and body returns the recorded result.
  • Money is integer minor units with an explicit currency. Only USD is accepted.
  • Lists are cursor-paged: 25 items by default, at most 100.
  • Responses carry a correlation reference. Send X-Correlation-Id to set your own.
API reference