Skip to content

Adfin API (1.0.0)

Adfin uses OAuth 2.0 access tokens to authenticate all API requests.

There are two contexts in which tokens are issued:

  • Biller Access Tokens — Generated via the Authorization Code flow when a biller connects their Adfin account. These tokens grant access to that biller's data (invoices, payment requests, customers, etc.).

  • Platform Access Tokens — Generated via the Client Credentials flow when a platform authenticates as itself rather than as one of its billers. A platform uses one to manage its own webhook subscriptions under /api/apps/{clientId}/webhooks.

Download OpenAPI description
direct-integration-api-reference.json
direct-integration-api-reference.yaml
Languages
Servers
Mock server
https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/
Production API Server URL
https://api.adfin.com/api/
Staging API Server URL
https://api.staging.adfin.com/api/

oAuth2

Operations

Biller

Operations

Verifications

Operations

Get a biller's verifications

Request

Returns the biller's verification history, latest first.

checks[] is ordered and open. Checks may be added, removed or reordered, so an integration must not switch exhaustively on key or fail on an unrecognised one.

A check that does not apply to a biller is left out of the list rather than sent with a status. A missing key means only that Adfin is not asking this biller for it right now.

Security
Biller Access Token (Production) or Biller Access Token (Staging)
Path
billerIdstring(uuid)required
curl -i -X GET \
  'https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/billers/{billerId}/verifications' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Verifications retrieved successfully.

Bodyapplication/json
verificationsArray of objects(BillerVerificationResponse)required

The biller's verification history, latest first.

verifications[].​verificationIdstring(uuid)required

The unique identifier of the verification.

verifications[].​typestringrequired

The type of verification.

Enum"ONBOARDING""REVERIFICATION"
verifications[].​statusstringrequired

The overall status, rolled up from the checks.

Enum"NOT_STARTED""OUTSTANDING""COMPLETED""IN_REVIEW""ACTION_REQUIRED""APPROVED""REJECTED""SUSPENDED"
verifications[].​waitingOnstring

Who has to act next. Omitted when nobody has to act.

Enum"BILLER""ADFIN"
verifications[].​creationTimestring(date-time)required

When the verification was created.

verifications[].​checksArray of objects(VerificationCheck)required

The checks that make up the verification, in the order a biller works through them.

verifications[].​checks[].​keystringrequired

What this check covers.

Enum"BUSINESS_DETAILS""BUSINESS_ADDRESS""DOCUMENTS""BANK_ACCOUNT""DECISION_MAKERS""IDENTITY_VERIFICATION""TERMS_AND_CONDITIONS""DIRECT_DEBIT_REVIEW"
verifications[].​checks[].​statusstringrequired

The status of this check.

Enum"NOT_STARTED""OUTSTANDING""COMPLETED""IN_REVIEW""ACTION_REQUIRED""APPROVED""REJECTED""SUSPENDED"
verifications[].​checks[].​waitingOnstring

Who has to act on this check. Omitted when nobody has to act.

Enum"BILLER""ADFIN"
verifications[].​checks[].​detailstring

Information on why the check is in this status.

Response
application/json
{
  "verifications": [
    { … }
  ]
}

Customers

Operations

Direct debit mandates

Operations

Invoices

Operations

Recurring invoices

Operations

Payment requests

Operations

Recurring payment requests

Operations

Payments

Operations

Payouts

Operations

Tax rates

Operations

Items

Operations

Workflows

Operations

Activities

What has happened to a customer, invoice, payment request or schedule.

Operations

Scheduled Activities

Operations

Webhooks

Operations