Step-by-step integration guide

Follow this journey in order: create access, connect a company, map your data, test in sandbox, then verify evidence before production.

Before you start

Authorized D2F Compliant Solution integration access.
A representative JSON payload from your source system.
The connected company’s legal identity.
A sandbox environment; no live regulatory delivery occurs during these steps.

Complete procedure

1REQUIRED

Create an API key

In Developer Portal, select D2F Compliant Solution, generate a named API key and copy it immediately. Regenerate keys created before 3.47.3 to obtain the CBM v2 scopes.

2REQUIRED

Connect the customer company

Open Integration Hub, add the company and retain its Connection ID.

3REQUIRED

Identify CBM fields

Use CBM Explorer to identify every source field and its declared responsibility.

4REQUIRED

Build the mapping

Paste a representative payload in Mapping Studio, map it to d2f.cbm.v2, resolve every issue and save a DRAFT version.

5REQUIRED

Test routing in sandbox

Enter the API key and Connection ID, then run a scenario. D2F automatically assigns provider.d2f.sandbox, so no live provider credentials are required. Inspect every execution and validation leg.

6REQUIRED

Test the API contract

Start with GET /capabilities, then organizations and mappings. Submit POST /transactions with a stable externalId and an Idempotency-Key.

7REQUIRED

Diagnose and retain evidence

Use the returned transaction ID in Diagnostics to inspect the plan, versions, blocking phase and SHA-256 evidence.

8REQUIRED

Move to production

Activate only after sandbox acceptance, qualified connector configuration and evidence review. Keep a rollback version.

Do not confuse these three identifiers

API KEYAuthenticates the technical client.

CONNECTION IDSelects the connected customer company.

TRANSACTION IDIdentifies one accepted transaction and its evidence.

Production checklist

✓ Dedicated active key
✓ Correct Connection ID
✓ Versioned valid mapping
✓ Successful sandbox simulation
✓ Qualified Country Pack and connector
✓ Source-managed idempotency
✓ No diagnostic blocker
✓ Evidence and rollback retained

Country Pack contributor journey

An approved partner uses the existing contract and governance. It adds neither a national engine, a readiness stage nor Business Suite rules.

Register the jurisdiction in the programme registry without qualifying it.
Create a manifest version in the Country Pack workspace and declare capabilities, applicability, official sources, rules, mappings and schema references.
Provide the Country Pack contract adapter for CBM mapping and response normalization, then declare any optional connector separately.
Run positive and negative tests, Sandbox scenarios and qualification controls, then attach evidence and documentation.
Submit D2F regulatory, technical and security reviews. A contributor cannot self-qualify or publish automatically.
Publish Marketplace metadata only after the controls pass; tenant activation and connector qualification remain separate.

This journey does not modify deriveTransactionReadiness, the CBM, stage orchestration, the Business Suite regulatory engine or Platform orchestration.

When a request fails

Record the HTTP status, request ID, correlation ID and transaction ID, then use Diagnostics. Scope errors require a new key; Connection ID errors concern company provisioning; CBM validation errors concern the payload or mapping.