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

Check your connection to the Griffin API.

Yields the legal-person.

Updates the legal-person.

Yields a list of all legal-persons in the organization.

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

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

Creates a new claim about a Legal Person.

Lists workflows for use when creating a verification.

Fetch the workflow.

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). The requirements for the sample workflows are:

Sample Workflow

This subject legal person must have a legal-person-type of corporation. It must have a uk-company-register claim and at least one director claim. It can optionally have a company-website claim, and one or more person-with-significant-control claims.

Each individual referenced by a director or person-with-significant-control claim must also have contact-details, individual-identity, and individual-residence claims.

Sample Individual Workflow

The subject legal person must have a legal-person-type of individual and the following claims: contact-details, individual-identity, individual-residence, mobile-number. It may optionally have the alternative-number claim.

Sample Sole Trader Workflow

The requirements are as per the Sample Individual Workflow above, except the subject legal person must have the sole-trader claim.

A 201 Created response indicates these requirements are met and verification will proceed. Otherwise, a 422 Unprocessable Entity response indicates there are insufficient claims, and verification cannot proceed.

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.

Fetch the verification.

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.

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

Fetch a bank account

Update a bank-account

Close a bank account

Yields a list of bank accounts where the beneficiary is this legal person.

POST creates a new bank account. Yields the same as GET to the [Bank] resource.

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

Lists all customer bank accounts under the control of this Organization.

Lists payments made from a bank account.

Registers a new payment request for the bank account

Lists payments made to a payee.

Yields payment details

Submits an outgoing payment.

Yields the list of bank account transactions.

Lists payees belonging to the legal person.

Registers a new payee for the customer

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 the organization details

Yields the User resource.

Returns a list of all roles assigned to this member of the organization.

Sets the roles assigned to the organization member to the list of roles provided.

A 422 is served if any of the given roles does not exist or does not appear in the Organization's available-roles.

Yields a list of all Role resources.

Yields the Role resource.

Yields the Membership resource.

Removes a user from an organization.

Returns a list of all users which are current members of the organization. Each user in the list has the same representation as the respective [User] resource.

Returns a list of all organizations where this user is a current member. Each organization in the list has the same representation as the respective [Organization] resource.