API Overview
Entry points, environments, and authentication for SI/AP endpoints.
Source: docs/api/overview.md
API Overview
High-level explanation of the Taxpoynt public API surface, versioning, and primary consumption patterns for SI/AP customers.
Documentation
Documentation & implementation playbooks
Everything you need to move from sandbox to production—API reference, SI/AP guidance, compliance commitments, and the guardrails our team enforces during onboarding.
Start here
Get to the right resource quickly
Use these links to jump straight into the references or policies your team needs.
API reference
REST endpoints, webhook payloads, and retry semantics for SI, AP, and hybrid flows.
Sandbox setup
Request sandbox access, generate keys, and send your first invoice to FIRS MBS safely.
Compliance & legal
Review Terms, Privacy, and Data Processing commitments used across SI and AP engagements.
Featured guides
Direct from our docs folder
Pulled from the repo so you can browse the latest guidance without leaving the site.
Sandbox to Production
Guardrails, approvals, and migration steps for moving between environments.
Source: docs/platform/sandbox-to-production.md
Sandbox to production flow
Sandbox (required first)
- Configure FIRS taxpayer config; Taxpoynt loads sandbox crypto keys for the taxpayer (customers are not expected to fetch keys).
- Use Dashboard “Quick Sandbox Test” to run ingest → IRN → QR in one call.
- Verify in Invoices list/detail and audit progress.
- Optional callbacks: set
callbackUrland confirm delivery with HMAC signature.
Promotion/KYC checklist
- Company details/KYC submitted and approved.
- Production FIRS credentials available (TIN, Service ID, business_id) and validated on the portal.
- Production crypto keyset received by Taxpoynt from FIRS (crypto_keys.txt) and stored securely by Taxpoynt.
- Support contacts + incident channel registered.
- At least one successful sandbox batch (e.g., N test invoices) with IRN + QR.
Move to Production
- Mirror config for Production: TIN/Service ID/businessName set, and Taxpoynt loads the production crypto keyset per environment.
- Enable SI service enrollment for Production (backend flag).
- Run a limited test with production credentials (ingest + IRN + QR) and confirm in Invoices detail + audit log.
- Gradually cut traffic: route a subset of ERP/connector calls to Production, monitor DLQ and validation rates.
UI reference
- Quick Sandbox Test card on
/org/[orgSlug]/dashboard. - Invoices list/detail to confirm IRN/QR.
- Audit and FIRS config pages for status per environment.
Onboarding Flow
What to expect as we enable SI/AP or hybrid for your organization.
Source: docs/platform/onboarding-flow.md
Onboarding Flow
Step-by-step onboarding flow for new SI/AP/Hybrid customers connecting to Taxpoynt.
What we document
Guides for every Taxpoynt path
Clear flows for the teams operating SI, Access Point, or hybrid orchestration.
System Integration (SI)
- Map ERP/POS payloads to MBS requirements with validation examples.
- Retry, acknowledgement, and IRN/QR generation flows.
- Callbacks, signatures, and observability for SI operators.
Access Point (AP)
- Invoice routing, counterparty delivery, and status tracking.
- Safeguards for duplicate submissions and idempotency.
- Operational playbooks for production cutover and rollback.
Hybrid
- Coordinated SI + AP lifecycles with shared monitoring.
- Playbooks for mixed environments and phased rollouts.
- Support for procurement, finance, and engineering stakeholders.
Implementation checklists
Move from sandbox to production with confidence
- ✓Decide on scope: SI, AP, or hybrid for your first environment.
- ✓Create sandbox credentials and whitelist callback URLs.
- ✓Send sample invoices and verify IRN/QR generation.
- ✓Validate webhook signatures, retries, and alerting destinations.
- ✓Document your go-live runbook with roll-forward/rollback paths.
Need something specific?
We’ll send the exact guide or sample payload
Tell us what you’re building—ERP integration, invoice routing, or compliance review—and our engineers will share the relevant snippets and checklists.