API reference
Inspect the bundled OpenAPI specification for request and response details. Confirm endpoint support against your deployed version.
OpenAPI specification →Developers / API & SDK
Use the PHP SDK for JSON requests, document uploads and the envelope lifecycle. Start with a read-only status request against your configured deployment.
01 / Install
Enable the cURL and JSON extensions. Composer resolves the available package release.
composer require robo-meister/accord-flow-api02 / Configure and call
Set ACCORDFLOW_BASE_URL to your deployment URL and ACCORDFLOW_TOKEN to a token provisioned for that deployment. Keep both configuration and credentials on the server.
Save this as status.php and run php status.php. The response is the deployment's JSON status. This checks API reachability; it does not certify signing-provider readiness or tenant permissions.
<?php
require __DIR__ . '/vendor/autoload.php';
use AccordFlow\AccordFlowClient;
use AccordFlow\AccordFlowException;
$baseUrl = getenv('ACCORDFLOW_BASE_URL');
$token = getenv('ACCORDFLOW_TOKEN');
if (!$baseUrl || !$token) {
throw new RuntimeException('Set the server-side AccordFlow URL and token.');
}
$client = new AccordFlowClient(
baseUrl: $baseUrl,
bearerToken: $token,
);
try {
$status = $client->status();
echo json_encode($status, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT);
} catch (AccordFlowException $error) {
// Log the status only; responses can contain sensitive signing data.
error_log('AccordFlow request failed; HTTP ' . $error->getStatusCode());
exit(1);
}
The client also accepts tenantId for deployments configured to use the tenant header. Follow your deployment's authentication policy.
03 / Build the signing flow
An envelope groups the document, recipients and signing lifecycle.
Dispatching an invitation does not establish signer consent. The signer supplies consent in the signing interaction. Final signed-document retrieval and evidence exports are separate operations; available artifacts depend on the runtime and provider.
Read the maintained lifecycle example and runtime requirements →Inspect the bundled OpenAPI specification for request and response details. Confirm endpoint support against your deployed version.
OpenAPI specification →Methods, uploads, error handling and version requirements in the public PHP repository.
PHP SDK README →Review provider dependencies and demo or beta limitations before planning your integration.
Capability details →