API Reference
Complete REST API endpoints for document verification, credential issuance, and identity management.
import { Authonex } from '@authonex/sdk';
const client = new Authonex({
apiKey: process.env.AUTHONEX_API_KEY,
environment: 'production', // or 'sandbox'
});
// Verify a document
const result = await client.decode.image({
image: fs.readFileSync('./license-front.jpg'),
});
console.log(result.trustScore); // 0.95
console.log(result.decision); // "allow"
// Issue a Verifiable Credential
const vc = await client.issue.vc({
license_id: result.licenseId,
});
// Generate 60-second ephemeral QR token
const token = await client.issue.ephemeralToken({
license_id: result.licenseId,
ttl_seconds: 60,
});
// Get ZKP age proof (no DOB exposed)
const proof = await client.issue.selectiveDisclosure({
license_id: result.licenseId,
claim: 'age_over_21',
});Authentication
/v1/auth/signupCreate a new account
/v1/auth/loginAuthenticate and receive token
Document Verification
/v1/public/decode/imageDecode PDF417 from uploaded image
/v1/public/decode/base64Decode PDF417 from base64 string
/v1/public/decode/aamvaParse raw AAMVA barcode text
/v1/public/qr/verifyVerify a QR token for validity
Identity & Credentials
/v1/walletCreate a new digital license
Requires authentication/v1/walletList all user licenses
Requires authentication/v1/wallet/:idGet license details
Requires authentication/v1/wallet/:id/revokeRevoke a license
Requires authentication/v1/issue/vcIssue W3C Verifiable Credential
Requires authentication/v1/issue/ephemeral-tokenGenerate 60s rotating QR token
Requires authentication/v1/issue/selective-disclosureRequest ZKP age/identity proof
Requires authentication/v1/issue/access-grantCreate time-bound access grant
Requires authenticationVerification
/v1/verify/ephemeral-tokenVerify an ephemeral QR token
Requires authentication/v1/verify/access-grantVerify an access grant
Requires authentication/v1/verify/public-keyGet Authonex public key
Organization & Teams
/v1/orgsCreate organization
Requires authentication/v1/orgsList organizations
Requires authentication/v1/orgs/:idGet organization details
Requires authentication/v1/orgs/:idUpdate organization
Requires authentication/v1/orgs/:id/membersInvite team member
Requires authentication/v1/orgs/:id/membersList team members
Requires authentication/v1/orgs/:id/members/:user_id/roleUpdate member role
Requires authentication/v1/orgs/:id/members/:user_idRemove member
Requires authenticationAPI Keys & Webhooks
/v1/keysCreate API key
Requires authentication/v1/keysList API keys
Requires authentication/v1/keys/:idDelete API key
Requires authentication/v1/keys/:id/rotateRotate API key
Requires authentication/v1/orgs/:id/webhooksCreate webhook
Requires authentication/v1/orgs/:id/webhooksList webhooks
Requires authentication/v1/orgs/:id/webhooks/:webhook_idDelete webhook
Requires authenticationLogs & Analytics
/v1/logsGet audit logs
Requires authentication/v1/orgs/:id/usageGet organization usage stats
Requires authentication/v1/public/plansList available pricing plans