Skip to main content

The Griffin API (0.3)

Download OpenAPI specification:Download

Connectivity

List URLs

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

Authorizations:
api-key-auth

Responses

Response samples

Content type
application/json
{
  • "organizations-url": "/v0/organizations",
  • "users-url": "/v0/users",
  • "roles-url": "/v0/roles",
  • "session-url": "/v0/session",
  • "api-key-url": "/v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA"
}

Ping

Check your connection to the Griffin API.

Responses

Legal Persons

Get legal person

Yields the legal-person.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string

Responses

Response samples

Content type
application/json
{
  • "individual-verifications-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
  • "latest-decision": {
    },
  • "claim-contact-details-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/contact-details",
  • "legal-person-type": "individual",
  • "claim-financial-service-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/financial-service",
  • "display-name": "Company name",
  • "application-status": "referred",
  • "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "claim-directors-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/directors",
  • "legal-person-decisions-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions",
  • "status-changed-at": "2019-08-24T14:15:22Z",
  • "created-at": "2019-08-24T14:15:22Z",
  • "claim-mobile-number-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/mobile-number",
  • "legal-person-claims-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims",
  • "legal-person-bank-payees-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees",
  • "legal-person-verifications-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
  • "corporation-verifications-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
  • "claim-registered-company-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/registered-company",
  • "claim-ultimate-beneficial-owners-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/ultimate-beneficial-owners",
  • "claim-alternative-number-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/alternative-number",
  • "bank-product-types-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/product-types",
  • "claim-residence-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/residence",
  • "claim-identity-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/identity",
  • "legal-person-documents-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents",
  • "bank-accounts-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/accounts"
}

Update legal person

Updates the legal-person.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
display-name
string (display-name)
application-status
string (application-status)
Enum: "referred" "declined" "submitted" "accepted"

Responses

Request samples

Content type
application/json
{
  • "display-name": "string",
  • "application-status": "referred"
}

Response samples

Content type
application/json
{
  • "individual-verifications-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
  • "latest-decision": {
    },
  • "claim-contact-details-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/contact-details",
  • "legal-person-type": "individual",
  • "claim-financial-service-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/financial-service",
  • "display-name": "Company name",
  • "application-status": "referred",
  • "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "claim-directors-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/directors",
  • "legal-person-decisions-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions",
  • "status-changed-at": "2019-08-24T14:15:22Z",
  • "created-at": "2019-08-24T14:15:22Z",
  • "claim-mobile-number-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/mobile-number",
  • "legal-person-claims-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims",
  • "legal-person-bank-payees-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees",
  • "legal-person-verifications-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
  • "corporation-verifications-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
  • "claim-registered-company-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/registered-company",
  • "claim-ultimate-beneficial-owners-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/ultimate-beneficial-owners",
  • "claim-alternative-number-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/alternative-number",
  • "bank-product-types-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/product-types",
  • "claim-residence-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/residence",
  • "claim-identity-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/identity",
  • "legal-person-documents-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents",
  • "bank-accounts-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/accounts"
}

List legal persons

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

Authorizations:
api-key-auth
path Parameters
organization-id
required
string

Responses

Response samples

Content type
application/json
{
  • "legal-persons": [
    ]
}

Create legal person

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

Authorizations:
api-key-auth
path Parameters
organization-id
required
string
Request Body schema: application/json
display-name
required
string (display-name)
legal-person-type
required
string (legal-person-type)
Enum: "individual" "corporation"
Array of objects (claim)

Responses

Request samples

Content type
application/json
{
  • "display-name": "string",
  • "legal-person-type": "individual",
  • "claims": [
    ]
}

Response samples

Content type
application/json
{
  • "individual-verifications-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
  • "latest-decision": {
    },
  • "claim-contact-details-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/contact-details",
  • "legal-person-type": "individual",
  • "claim-financial-service-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/financial-service",
  • "display-name": "Company name",
  • "application-status": "referred",
  • "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "claim-directors-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/directors",
  • "legal-person-decisions-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/decisions",
  • "status-changed-at": "2019-08-24T14:15:22Z",
  • "created-at": "2019-08-24T14:15:22Z",
  • "claim-mobile-number-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/mobile-number",
  • "legal-person-claims-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/claims",
  • "legal-person-bank-payees-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/payees",
  • "legal-person-verifications-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
  • "corporation-verifications-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
  • "claim-registered-company-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/registered-company",
  • "claim-ultimate-beneficial-owners-url": "/v0/corporations/lp.IGxlZ2FsLXBlcnNvbi1pZA/ultimate-beneficial-owners",
  • "claim-alternative-number-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/alternative-number",
  • "bank-product-types-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/product-types",
  • "claim-residence-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/residence",
  • "claim-identity-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/identity",
  • "legal-person-documents-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents",
  • "bank-accounts-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/accounts"
}

Claims

Claim company website

Creates a new claim about the corporation's website.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
website-url
required
string

Responses

Request samples

Content type
application/json
{
  • "website-url": "string"
}

Response samples

Content type
application/json
{
  • "claim-data": {
    },
  • "claim-type": "mobile-number"
}

Claim director

Creates a new claim about a corporation's director.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
legal-person-url
required
string (legal-person-url)
companies-house-url
string (companies-house-url)

The URL of the entity in Companies House

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "claim-data": {
    },
  • "claim-type": "mobile-number"
}

Claim registered company

Creates a new claim about a corporation's registration at Companies House, including its registered office address and contact details.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
email-address
string (email-address)
city
required
string
building-name
string
street-name
required
string
entity-name
required
string
postal-code
required
string
corporation-type
required
string (corporation-type)
Enum: "private-limited-guarant-nsc-limited-exemption" "eeig" "private-limited-shares-section-30-exemption" "limited-partnership" "royal-charter" "private-unlimited-nsc" "old-public-company" "investment-company-with-variable-capital" "other-company-type" "converted-or-closed" "protected-cell-company" "private-limited-guarant-nsc" "scottish-charitable-incorporated-organisation" "industrial-and-provident-society" "registered-society-non-jurisdictional" "private-unlimited" "further-education-or-sixth-form-college-corporation" "limited-liability-partnership" "assurance-company" "other" "northern-ireland-other" "charitable-incorporated-organisation" "oversea-company" "icvc-securities" "uk-establishment" "unregistered-company" "icvc-warrant" "registered-overseas-entity" "public-limited-company" "private-limited-company" "european-public-limited-liability-company-se" "private-unlimted-nsc" "northern-ireland" "icvc-umbrella" "scottish-partnership"
telephone-number
string
building-number
string
country-code
required
string (country-code)

ISO 3166-1 alpha-2 two-letter country code.

date-of-incorporation
string <date> (date-of-incorporation)

ISO 8601 formatted date.

entity-registration-number
required
string (entity-registration-number)

The entity number assigned by the local register. For UK companies that's the Companies House company number.

Responses

Request samples

Content type
application/json
{
  • "email-address": "string",
  • "city": "string",
  • "building-name": "string",
  • "street-name": "string",
  • "entity-name": "string",
  • "postal-code": "string",
  • "corporation-type": "private-limited-guarant-nsc-limited-exemption",
  • "telephone-number": "string",
  • "building-number": "string",
  • "country-code": "GB",
  • "date-of-incorporation": "2019-08-24",
  • "entity-registration-number": "string"
}

Response samples

Content type
application/json
{
  • "claim-data": {
    },
  • "claim-type": "mobile-number"
}

Claim ultimate beneficial owner

Creates a new claim about one of the corporation's ultimate beneficial owners.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
legal-person-url
required
string (legal-person-url)
ownership-percent
required
string

The percentage ownership the legal person has of the corporation.

companies-house-url
string (companies-house-url)

The URL of the entity in Companies House

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "claim-data": {
    },
  • "claim-type": "mobile-number"
}

Claim alternative number

Creates a new claim about an individual's alternative phone number.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
telephone-number
required
string

Responses

Request samples

Content type
application/json
{
  • "telephone-number": "string"
}

Response samples

Content type
application/json
{
  • "claim-data": {
    },
  • "claim-type": "mobile-number"
}

Claim contact details

Creates a new claim about an individual's contact details.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
email-address
required
string (email-address)
mobile-number
string
telephone-number
string

Responses

Request samples

Content type
application/json
{
  • "email-address": "string",
  • "mobile-number": "string",
  • "telephone-number": "string"
}

Response samples

Content type
application/json
{
  • "claim-data": {
    },
  • "claim-type": "mobile-number"
}

Claim identity

Creates a new claim about an individual's identity.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
date-of-birth
required
string <date> (date-of-birth)

ISO 8601 formatted date.

given-name
required
string
surname
required
string
middle-name
string

Responses

Request samples

Content type
application/json
{
  • "date-of-birth": "2019-08-24",
  • "given-name": "string",
  • "surname": "string",
  • "middle-name": "string"
}

Response samples

Content type
application/json
{
  • "claim-data": {
    },
  • "claim-type": "mobile-number"
}

Claim mobile number

Creates a new claim about an individual's mobile phone number.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
mobile-number
required
string

Responses

Request samples

Content type
application/json
{
  • "mobile-number": "string"
}

Response samples

Content type
application/json
{
  • "claim-data": {
    },
  • "claim-type": "mobile-number"
}

Claim residence

Creates a new claim about an individual's residential address.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
Any of
building-name
required
string
street-name
required
string
city
required
string
postal-code
required
string
country-code
required
string (country-code)

ISO 3166-1 alpha-2 two-letter country code.

Responses

Request samples

Content type
application/json
{
  • "building-number": "string",
  • "street-name": "string",
  • "city": "string",
  • "postal-code": "string",
  • "country-code": "GB"
}

Response samples

Content type
application/json
{
  • "claim-data": {
    },
  • "claim-type": "mobile-number"
}

List claims

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

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string

Responses

Response samples

Content type
application/json
{
  • "claims": [
    ]
}

Workflows

List organization workflows

Lists workflows for use when creating a verification.

Authorizations:
api-key-auth
path Parameters
organization-id
required
string

Responses

Response samples

Content type
application/json
{
  • "workflows": [
    ]
}

Get workflow

Fetch the workflow.

Authorizations:
api-key-auth
path Parameters
workflow-id
required
string

Responses

Response samples

Content type
application/json
{
  • "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA",
  • "display-name": "string",
  • "legal-person-type": "individual"
}

Verifications

List verifications for a legal person

List verifications for the given legal person.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Perform verification of a legal person

Initiates verification of the company or individual legal person.

The request body must include a workflow-url, to determine checks to be performed by the verification. Additionally, to verify a company, it should already have a uk-company-register claim, at least one director claim, and optionally one or more ultimate-beneficial-owner claims. Each individual referenced by a director or ultimate-beneficial-owner claim should also have contact-details, individual-identity, and individual-residence claims.

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.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
workflow-url
required
string (workflow-url)

Responses

Request samples

Content type
application/json
{
  • "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA"
}

Get verification

Fetch the verification.

Authorizations:
api-key-auth
path Parameters
verification-id
required
string

Responses

Response samples

Content type
application/json
{
  • "created-at": "2019-08-24T14:15:22Z",
  • "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "verification-status": "in-progress",
  • "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
  • "verification-checks-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/checks",
  • "risk-rating": "high-risk",
  • "updated-at": "2019-08-24T14:15:22Z",
  • "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA"
}

Decisions

List decisions

Lists all decisions for the given legal-person.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string

Responses

Response samples

Content type
application/json
{
  • "decisions": [
    ]
}

Create decision

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.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
verification-url
required
string (verification-url)
decision-outcome
required
string (decision-outcome)
Enum: "accepted" "declined"
decision-notes
required
string (decision-notes)

Free text to hold reasons for making the decision.

Responses

Request samples

Content type
application/json
{
  • "verification-url": "string",
  • "decision-outcome": "accepted",
  • "decision-notes": "string"
}

Response samples

Content type
application/json
{
  • "verification-url": "string",
  • "decision-outcome": "accepted",
  • "decision-maker": "system",
  • "decision-notes": "string",
  • "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
  • "decision-user-username": "user@example.com",
  • "created-at": "2019-08-24T14:15:22Z"
}

Companies House

Lookup company

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

Authorizations:
api-key-auth
path Parameters
company-number
required
string
Example: 10842931

UK Companies House company number

Responses

Response samples

Content type
application/json
{
  • "company-address": {
    },
  • "date-of-latest-accounts": "2019-08-24",
  • "entity-name": "string",
  • "directors": [],
  • "date-of-latest-confirmation-statement": "2019-08-24",
  • "corporation-type": "private-limited-guarant-nsc-limited-exemption",
  • "company-status": "dissolved",
  • "accounts-overdue": true,
  • "persons-with-significant-control": [],
  • "confirmation-statement-overdue": true,
  • "date-of-incorporation": "2019-08-24",
  • "entity-registration-number": "string"
}

Bank Accounts

Get bank account

Fetch a bank account

Authorizations:
api-key-auth
path Parameters
bank-account-id
required
string

Responses

Response samples

Content type
application/json
{
  • "account-payments-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments",
  • "bank-product-type": "client-money-account",
  • "display-name": "Reserve a/c",
  • "controller-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "account-status": "open",
  • "owner-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "available-balance": {
    },
  • "account-transactions-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions",
  • "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA",
  • "beneficiary-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "account-balance": {
    }
}

List legal person bank accounts

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

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ]
}

Create bank account

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

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
bank-product-type
required
string (bank-product-type)
Enum: "client-money-account" "safeguarding-account" "business-demand-account"
display-name
required
string (display-name)

Responses

Request samples

Content type
application/json
{
  • "bank-product-type": "client-money-account",
  • "display-name": "string"
}

Response samples

Content type
application/json
{
  • "account-payments-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments",
  • "bank-product-type": "client-money-account",
  • "display-name": "Reserve a/c",
  • "controller-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "account-status": "open",
  • "owner-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "available-balance": {
    },
  • "account-transactions-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/transactions",
  • "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA",
  • "beneficiary-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "account-balance": {
    }
}

List bank accounts

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

Authorizations:
api-key-auth
path Parameters
organization-id
required
string

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ]
}

Payments

List bank account payments

Lists payments made from a bank account.

Authorizations:
api-key-auth
path Parameters
bank-account-id
required
string

Responses

Response samples

Content type
application/json
{
  • "payments": [
    ]
}

Create payment

Registers a new payment request for the bank account

Authorizations:
api-key-auth
path Parameters
bank-account-id
required
string
Request Body schema: application/json
payee-url
required
string (payee-url)
required
object (payment-amount)
payment-reference
required
string (payment-reference) [ 1 .. 35 ] characters

Responses

Request samples

Content type
application/json
{
  • "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
  • "payment-amount": {
    },
  • "payment-reference": "string"
}

Response samples

Content type
application/json
{
  • "payment-submission-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submission",
  • "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
  • "payment-status": "failed",
  • "payment-direction": "inbound-payment",
  • "created-at": "2019-08-24T14:15:22Z",
  • "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
  • "payment-reference": "string",
  • "payment-amount": {
    },
  • "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}

List payee payments

Lists payments made to a payee.

Authorizations:
api-key-auth
path Parameters
payee-id
required
string

Responses

Response samples

Content type
application/json
{
  • "payments": [
    ]
}

Get payment

Yields payment details

Authorizations:
api-key-auth
path Parameters
payment-id
required
string

Responses

Response samples

Content type
application/json
{
  • "payment-submission-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submission",
  • "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
  • "payment-status": "failed",
  • "payment-direction": "inbound-payment",
  • "created-at": "2019-08-24T14:15:22Z",
  • "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
  • "payment-reference": "string",
  • "payment-amount": {
    },
  • "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}

Submit payment

Submits an outgoing payment.

Authorizations:
api-key-auth
path Parameters
payment-id
required
string

Responses

Response samples

Content type
application/json
{
  • "payment-submission-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submission",
  • "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
  • "payment-status": "failed",
  • "payment-direction": "inbound-payment",
  • "created-at": "2019-08-24T14:15:22Z",
  • "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
  • "payment-reference": "string",
  • "payment-amount": {
    },
  • "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}

Transactions

List transactions

Yields the list of bank account transactions.

Authorizations:
api-key-auth
path Parameters
bank-account-id
required
string

Responses

Response samples

Content type
application/json
{
  • "account-transactions": [
    ],
  • "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}

Transfers

Get transfer

Yields the bank transfer details

Authorizations:
api-key-auth
path Parameters
transfer-id
required
string

Responses

Response samples

Content type
application/json
{
  • "request-inst": "2019-08-24T14:15:22Z",
  • "transfer-items": [
    ],
  • "transfer-url": "/v0/bank/transfers/tr.ICAgICB0cmFuc2Zlci1pZA"
}

Create transfer

A transfer is a movement of money between Griffin bank accounts. When successfully created, a transfer results in a new entry in each associated account's [Account Transactions].

Authorizations:
api-key-auth
path Parameters
organization-id
required
string
Request Body schema: application/json
required
Array of objects (transfer-items) >= 2 items
Array (>= 2 items)
required
object (account-balance-change)
account-url
required
string (account-url)

Responses

Request samples

Content type
application/json
{
  • "transfer-items": [
    ]
}

Response samples

Content type
application/json
{
  • "request-inst": "2019-08-24T14:15:22Z",
  • "transfer-items": [
    ],
  • "transfer-url": "/v0/bank/transfers/tr.ICAgICB0cmFuc2Zlci1pZA"
}

Payees

List legal person payees

Lists payees belonging to the legal person.

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string

Responses

Response samples

Content type
application/json
{
  • "payees": [
    ]
}

Create payee

Registers a new payee for the customer

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string
Request Body schema: application/json
account-holder
required
string (account-holder)

The name of the account holder.

account-number
required
string (account-number)
bank-id
required
string (bank-id) = 6 characters

Responses

Request samples

Content type
application/json
{
  • "account-holder": "string",
  • "account-number": "12345678",
  • "bank-id": "123456"
}

Response samples

Content type
application/json
{
  • "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
  • "account-number": "12345678",
  • "account-holder": "string",
  • "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "bank-id": "123456",
  • "created-at": "2019-08-24T14:15:22Z",
  • "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA",
  • "payee-payments-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA/payments",
  • "country-code": "GB"
}

Get payee

Yields payee details

Authorizations:
api-key-auth
path Parameters
payee-id
required
string

Responses

Response samples

Content type
application/json
{
  • "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
  • "account-number": "12345678",
  • "account-holder": "string",
  • "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "bank-id": "123456",
  • "created-at": "2019-08-24T14:15:22Z",
  • "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA",
  • "payee-payments-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA/payments",
  • "country-code": "GB"
}

Product Types

List product types

Yields the Griffin banking products available to this Legal Person

Authorizations:
api-key-auth
path Parameters
legal-person-id
required
string

Responses

Response samples

Content type
application/json
{
  • "bank-product-types": [
    ]
}

Organizations

Get organization

Yields the organization details

Authorizations:
api-key-auth
path Parameters
organization-id
required
string

Responses

Response samples

Content type
application/json
{
  • "own-legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "organization-mode": "test-mode",
  • "organization-memberships-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships",
  • "organization-invitations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations",
  • "display-name": "Company Org",
  • "organization-api-keys-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys",
  • "charts-of-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/charts-of-accounts",
  • "exports-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/exports",
  • "journal-entries-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/ledger/journal-entries",
  • "organization-workflows-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows",
  • "organization-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts",
  • "transfers-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/transfers",
  • "organization-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA",
  • "organization-verifications-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/verifications",
  • "organization-individuals-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals",
  • "organization-corporations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations",
  • "organization-legal-persons-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons",
  • "organization-trial-balance-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/ledger/trial-balance",
  • "ledgers-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/ledger/accounts"
}

Update organization

PUT updates the organization. The only field that may be updated is the name. Responds with the same body as a GET to the [organization] resource.

Authorizations:
api-key-auth
path Parameters
organization-id
required
string
Request Body schema: application/json
display-name
string (display-name)

Responses

Request samples

Content type
application/json
{
  • "display-name": "string"
}

Response samples

Content type
application/json
{
  • "own-legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
  • "organization-mode": "test-mode",
  • "organization-memberships-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships",
  • "organization-invitations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations",
  • "display-name": "string",
  • "organization-api-keys-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys",
  • "charts-of-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/charts-of-accounts",
  • "exports-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/exports",
  • "journal-entries-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/ledger/journal-entries",
  • "organization-workflows-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows",
  • "organization-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts",
  • "transfers-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/transfers",
  • "organization-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA",
  • "organization-verifications-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/verifications",
  • "organization-individuals-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/individuals",
  • "organization-corporations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/corporations",
  • "organization-legal-persons-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/legal-persons",
  • "organization-trial-balance-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/ledger/trial-balance",
  • "ledgers-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/ledger/accounts"
}

Users

Get user

Yields the User resource.

Authorizations:
api-key-auth
path Parameters
user-id
required
string

Responses

Response samples

Content type
application/json
{
  • "user-email": "user@example.com",
  • "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
  • "user-username": "user@example.com",
  • "api-keys-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys",
  • "user-memberships-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships",
  • "given-name": "string",
  • "surname": "string"
}

Roles

List membership roles

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

Authorizations:
api-key-auth
path Parameters
membership-id
required
string

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Update role

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

Authorizations:
api-key-auth
path Parameters
membership-id
required
string
Request Body schema: application/json
role-urls
required
Array of strings (role-url)

Responses

Request samples

Content type
application/json
{
  • "role-urls": [
    ]
}

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

List roles

Yields a list of all Role resources.

Authorizations:
api-key-auth

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Get role

Yields the Role resource.

Authorizations:
api-key-auth
path Parameters
role-id
required
string

Responses

Response samples

Content type
application/json
{
  • "display-name": "string",
  • "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}

Memberships

Get membership

Yields the Membership resource.

Authorizations:
api-key-auth
path Parameters
membership-id
required
string

Responses

Response samples

Content type
application/json
{
  • "membership-url": "/v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA",
  • "membership-roles-url": "/v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles",
  • "organization": {
    },
  • "roles": [
    ],
  • "user": {
    }
}

Delete membership

Removes a user from an organization.

Authorizations:
api-key-auth
path Parameters
membership-id
required
string

Responses

List organization memberships

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.

Authorizations:
api-key-auth
path Parameters
organization-id
required
string

Responses

Response samples

Content type
application/json
{
  • "memberships": [
    ]
}

List user memberships

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.

Authorizations:
api-key-auth
path Parameters
user-id
required
string

Responses

Response samples

Content type
application/json
{
  • "memberships": [
    ]
}

API keys

Get API key

Yields the API Key without api-key-secret

Authorizations:
api-key-auth
path Parameters
api-key-id
required
string

Responses

Response samples

Content type
application/json
{
  • "api-key-url": "/v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA",
  • "api-key-name": "buildserver",
  • "api-key-live?": true,
  • "organization-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA",
  • "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA"
}

Delete API key

Deletes the API Key.

Authorizations:
api-key-auth
path Parameters
api-key-id
required
string

Responses

List API keys

Yields the list of maps, each the same as GET to the respective [API Key] resource.

Authorizations:
api-key-auth
path Parameters
organization-id
required
string

Responses

Response samples

Content type
application/json
{
  • "api-keys": [
    ]
}

Create API Key

POST creates a new API Key. This is only time the api-key-secret is returned.

Authorizations:
api-key-auth
path Parameters
organization-id
required
string
Request Body schema: application/json
api-key-name
required
string (api-key-name)

The name of the API Key. Cannot contain whitespace.

Responses

Request samples

Content type
application/json
{
  • "api-key-name": "string"
}

Response samples

Content type
application/json
{
  • "api-key-url": "/v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA",
  • "api-key-name": "buildserver",
  • "api-key-live?": true,
  • "organization-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA",
  • "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
  • "api-key-secret": "g-test-buildserver-RrUZ5fUG4pSKwYVVG1C3Ft1xrMRxy1T7KUIyTva5bTk"
}

List API keys

Yields the list of maps, each the same as GET to the respective [API Key] resource.

Authorizations:
api-key-auth
path Parameters
user-id
required
string

Responses

Response samples

Content type
application/json
{
  • "api-keys": [
    ]
}