From access to a connected workflow.

Arrange organization access

Contact AEGVEN with a high-level description of the workflow. We arrange your development environment, organization, and initial individual administrator access. There is no self-service account registration or live financial account offered through this website.

Your administrator can invite colleagues and assign roles. Administrators and developers can operate supported workflows and manage integrations. Reviewers can inspect records and documents without making changes or retrieving hosted access links.

Decide who owns customer communication, reviews payment evidence, handles integration issues, and approves changes to your source records. For a business-oriented introduction, see how AEGVEN works for your team.

Prepare the integration server

1. Create a named machine credential.

   An administrator or developer creates the credential under Developers → API keys using individual console access. Store the one-time secret in your server’s secret manager.

2. Install the approved SDK.

   Choose TypeScript/JavaScript, Python, C#/.NET, or Go. Verify the supplied file and pin the version. You can also call the versioned REST API directly.

3. Configure the assigned environment.

   Set AEGVEN_API_URL to your API base URL including /api/v1, and AEGVEN_API_KEY to the machine credential. Keep test and live configurations separate.

API keys cannot sign a person into the console. Recipients need neither a machine credential nor an SDK. To rotate a credential, install its replacement, check successful use, then revoke the old key. A previously shown secret cannot be recovered from operation lookup.

Connect and test event delivery

Set up the receiver before registering obligations. Use an HTTPS endpoint and a server-held signing secret of 32–256 characters. Verify incoming signatures against the raw body, then durably accept and deduplicate each event.

// aegven is your configured server-side SDK client.
// Use the endpoint URL and random signing secret from your protected configuration.
const endpoint = await aegven.registerWebhook(
  receiverUrl,
  signingSecret,
  'configure-primary-events-v1',
);
await aegven.control.testEndpoint(endpoint.id, 'test-primary-events-v1');

// Delivery is asynchronous. Inspect results after the receiver handles the test.
const deliveries = await aegven.deliveries();
const readiness = await aegven.control.readiness();
// Review readiness.webhook_test_successful and the relevant delivery result.

Handle tests separately

A test envelope has type: integration.test and resource_type: webhook_endpoint. It contains no obligation. Authenticate and deduplicate it, but do not apply a financial update. Financial envelopes carry the obligation context described in the event guide.

Plan for retries and rotation

Inspect delivery state, HTTP status, and attempt history. Failed deliveries can be retried explicitly; your receiver must still deduplicate the stable event ID. An acknowledgement means the receiver accepted the event, not that your downstream business update finished.

Retest after changing endpoint configuration or its signing secret. During a signing-secret rotation, allow the old and new receiver secrets for the in-flight transition, then retire the old one. Secrets are disclosed once; use a deliberate replacement if that response is lost.

The readiness response reports setup checks such as configured access, hosted workflow availability, and a successful webhook test. It is not an approval for production use or a guarantee of service availability.

Connect your customer communication

Register an obligation from the original source record. Store its ID and returned hosted URL securely, then insert the link in your normal outgoing message and retain your original attachment. AEGVEN does not automatically send that message for your business.

Keep a stable message identifier in your sending process so retrying registration does not send duplicate customer messages. Report the sent action only after your mail transport accepts the message. Open and acknowledgement activity are separate facts.

The customer opens a scoped secure interaction without an account. They can acknowledge receipt, provide a date or payment report, share documents, and exchange messages. They continue using your existing payment method.

Exclude hosted links from logs, analytics, public exports, and webhook payloads. Expired or revoked access returns HTTP 410. Replaying registration does not renew the link; ask the authorized team to review access.

Start with a CSV workflow

The console and SDK support a generic CSV import for invoice-based obligations. It is useful for a controlled file-based starting point. Use profile aegven.obligations.v1 and the supplied column order:

profile,obligation_type,external_namespace,external_id,source_reference,debtor_name,debtor_email,amount_minor,currency,deadline,description

1. Fill the template with stable source identities, exact minor-unit strings, uppercase currency codes, and YYYY-MM-DD deadlines.
2. Preview the file and inspect every row error. Preview does not create accepted obligations.
3. Correct the file and preview it again if it changes.
4. Accept the reviewed file using the same raw CSV and stable batch key. Acceptance applies the complete batch or none of it.

The current development profile supports up to 50 rows and 512 KB per batch. Use control.previewImport and control.acceptImport in TypeScript, or the corresponding methods in your language SDK.

Accepted-result exports include source identity, status, amounts, accepted allocation, and version information. They exclude hosted access links, credentials, and document contents. Exports cover up to 10,000 records; use paginated API queries for larger sets. CSV import does not itself dispatch your customer messages.

Validate the complete journey

Start with fictional data in your assigned development environment:

1. Register an obligation and confirm the mapping to the original record.
2. Retry the same registration and verify that it does not create another obligation or duplicate your outgoing message.
3. Open the secure link as the recipient, acknowledge receipt, share a date, and report a payment.
4. Confirm the report remains unverified in your business system.
5. Have the authorized team add and review independent payment evidence. Check partial and full reconciliation separately.
6. Test a duplicate and an out-of-order webhook, a failed delivery, and an ambiguous request result.
7. Confirm access expiry, credential rotation, and your team’s handling of unresolved items.

Before live use, agree the supported scope, responsibilities, access, and operational readiness with AEGVEN. Development access and a successful test do not make the service available in every market.

Use the reference for your environment

Find installation packages, rendered guides, and the public API contract in the AEGVEN developer portal:

• Quickstart — register your first obligation and connect the workflow.
• SDK guide — language examples, retries, and webhook verification.
• API reference — request and response contracts.

Confirm your assigned environment and supported version during onboarding.