Griffin Banking API

Contains various global URL paths. Follow api-key-url to discover your organization-url. Mocked via Mockzilla.

Check your connection to the Griffin API.

Yields an admission.

Returns the API key without api-key-secret.

Deletes the API Key. This operation cannot be undone.

Fetch a bank account. Available as a Mockzilla mock endpoint.

Update a bank account

Close a bank account

Lists admissions targeting a bank account

List legal persons in a pooled account membership

Add and update the legal persons in a pooled account membership. Limited to 2000 legal persons per operation. Mockzilla mock: no signup, no API key.

Lists payments made from a bank account.

Registers a new payment request for the bank account

Lists submissions originating from a bank account

Lists balance changes on a bank account.

Yields a bank account transaction. Served by the Mockzilla mock runtime.

Lookup Companies House company by company number. Includes information about the company, its directors, and persons with significant control.

Get an event

Yields the legal-person.

Updates the legal-person.

Lists payees belonging to the legal person. Mocked via Mockzilla.

Registers a new payee for the customer

Yields a list of all current claims about this Legal Person.

Creates a new claim about a Legal Person.

Lists all decisions for the given legal-person.

Creates a decision against the legal person. The provided verification must have a verification-status of checks-complete, otherwise a 422 is served. When a decision is successfully created, the legal person's application-status is updated accordingly. Multiple decisions may be made against the same legal person. Available as a Mockzilla mock endpoint.

Lists history of events for the given legal person.

List verifications for the given legal person.

Initiates verification of the subject legal person. The request body must include a workflow-url to determine checks to be performed by the verification. The workflow specified determines which claims must exist for the subject legal person, as identified in the request URL, and any associated legal persons (i.e. directors and people with significant control of a corporation). These claims can be found in the required-claim-types field on a Workflow. Once a verification is created, the system will perform checks on the claim details. The status of check processing is indicated by the verification-status in the response body. Initially it will be pending, and will transition through in-progress to a final status of checks-complete. A verification-status of failed indicates something went wrong during check processing. You can initiate another verification to retry the check processing.

Returns the user's membership information.

Removes a user from an organization. Mockzilla mock: no signup, no API key.

Returns the roles assigned to this membership.

Assigns roles to the membership. A 422 is served if you provide a role that is not in the Organisations "available-roles".

Fetch an onboarding application.

Yields the organization details

List all active API keys in your organization. Served by the Mockzilla mock runtime.

Create a new API key. This is the only time api-key-secret is shown.

Yields a list of all bank accounts under the control of this Organization.

Open a new bank account

List all events for an organization

POST creates a new invitation to the organization. Sends an email invitation to join the organization to the specified email-address. Mocked via Mockzilla.

Returns a paginated list of all legal persons for the given organization. By default, results are sorted descending by created-at (newest first). To sort ascending by created-at, provide a ?sort=created-at query parameter.

Creates a new Legal Person. A collection of Claims may be provided.

Returns this organization's memberships.

Create an onboarding application and submit it for processing. The request body must include a workflow-url to determine checks to be performed by the verification. The workflow specified determines which claims must exist for the subject profile, and any related profile (i.e. directors and people with significant control of a corporation). At the moment we only support 3 reliance workflows: Reliance LTD Company, Reliance Individual and Reliance Sole Trader. You need to provide different claims depending on the type of customer you wish to onboard via reliance. | LTD Company | Individual | Sole trader | | ----------- | ---------- | ----------- | | Subject profile:uk-company-registertrading-addressreliance-verificationRelated profiles:individual-identityindividual-residencereliance-verification | Subject profile:individual-identityindividual-residencereliance-verification | Subject profile:business-nameindividual-identityindividual-residencereliance-verification | For more information see our reliance onboarding guide.

Get all webhooks for the organization. Available as a Mockzilla mock endpoint.

Create a webhook

Lists workflows for use when creating a verification.

Yields payee details

Updates an existing payee. A payee can be deactivated by updating the payee-status of an active payee to deactivated. Any attempt to create or submit a payment to a deactivated payee will fail. A 422 is served when attempting to deactivate an already-deactivated payee.

Yields payment details. Mockzilla mock: no signup, no API key.

Lists admissions for a payment. A payment may have at most one admission.

Lists submissions for a payment. The presence of a submission means that the payment has been submitted.

Submits a previously created payment for execution.

Yields a list of all Role resources.

Yields the Role resource. Served by the Mockzilla mock runtime.

Yields a submission.

Get the User resource for the current user.

List all your active API keys.

Returns this user's memberships.

Fetch the verification. Mocked via Mockzilla.

Fetch a webhook

Delete a webhook

Update a webhook

Activate a webhook

Deactivate a webhook. Available as a Mockzilla mock endpoint.

Get the status of the latest test event

Send a test event to the webhook

Fetch the workflow.