@credona/age-decision
v2.5.0
Published
JavaScript and TypeScript SDK for Age Decision API.
Maintainers
Readme
Age Decision JS SDK is a TypeScript and JavaScript client for the Age Decision API.
This repository owns the typed JavaScript and TypeScript client interface for Age Decision API consumers.
It provides a typed fetch-based client for health, version, readiness, and verification endpoints.
It does not perform age estimation or anti-spoofing locally.
It does not load, download, store, or redistribute machine learning model files.
Version 2.3.0 adds StandardizedApiError for gateway ErrorResponse failures: HTTP 400 and 502 standardized envelopes are mapped from AgeDecisionClient using strict privacy-first validation; all other failures stay on HttpError (timeouts unchanged).
- you want to integrate Age Decision in a frontend or Node.js app
- you need typed API access
- you want quick integration
- you want backend orchestration
- you want direct model usage
- you want to modify decision logic
- Repository: https://github.com/credona/age-decision-js
- Usage: docs/usage.md
- Deprecation policy: docs/deprecation-policy.md
- Error model: docs/error-model.md
- Status contract: docs/status-contract.md
- API types: docs/types.md
- Compatibility: docs/compatibility.md
- Security: SECURITY.md
- Global architecture and ownership: https://github.com/credona/age-decision/blob/main/docs/architecture.md
- Global scoring model: https://github.com/credona/age-decision/blob/main/docs/scoring.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Global project: https://github.com/credona/age-decision
npm install @credona/age-decisionimport { AgeDecisionClient } from "@credona/age-decision";
const client = new AgeDecisionClient({
baseUrl: "https://your-age-decision-api.example.com",
timeout: 5000,
retries: 1,
retryDelay: 300,
});
const version = await client.version();
console.log(version.version);
console.log(version.contract_version);
const result = await client.verify({
imageBase64: "base64-image",
ageThreshold: 18,
majorityCountry: "FR",
});
console.log(result.decision);
console.log(result.cred_global_score);This SDK:
- calls an Age Decision API instance
- provides typed request and response contracts
- handles request tracing
- handles timeouts
- handles retries
- exposes HTTP errors (HttpError, StandardizedApiError)
- exposes typed project version metadata
It does not:
- perform local age estimation
- perform local anti-spoofing
- load model files
- download model files
- redistribute model files
- store images
- generate Zero-Knowledge proofs
- replace certified legal identity checks
- perform face recognition
For package metadata, compatibility details, developer workflows, integration tests, and advanced setup, see docs/usage.md.
This repository is released under the Apache License 2.0.
See LICENSE for details.
