List URLs
Contains various global URL paths. Follow api-key-url
to discover your organization-url
.
Authorizations:
Responses
Response samples
- 200
{- "organizations-url": "/v0/organizations",
- "users-url": "/v0/users",
- "roles-url": "/v0/roles",
- "session-url": "/v0/session",
- "api-key-url": "/v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA",
- "organization-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA"
}
Get legal person
Yields the legal-person.
Authorizations:
path Parameters
legal-person-id required | string |
Responses
Response samples
- 200
{- "individual-verifications-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
- "latest-decision": {
- "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
- "decision-outcome": "accepted",
- "decision-maker": "system",
- "decision-notes": "string",
- "created-at": "2019-08-24T14:15:22Z",
- "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
- "decision-user-username": "user@example.com"
}, - "legal-person-type": "individual",
- "display-name": "Company name",
- "application-status": "referred",
- "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "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",
- "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",
- "bank-product-types-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/product-types",
- "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:
path Parameters
legal-person-id required | string |
Request Body schema: application/json
display-name | string (display-name) non-empty |
application-status | string (application-status) Enum: "referred" "declined" "submitted" "accepted" |
Responses
Request samples
- Payload
{- "display-name": "string",
- "application-status": "referred"
}
Response samples
- 200
{- "individual-verifications-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
- "latest-decision": {
- "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
- "decision-outcome": "accepted",
- "decision-maker": "system",
- "decision-notes": "string",
- "created-at": "2019-08-24T14:15:22Z",
- "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
- "decision-user-username": "user@example.com"
}, - "legal-person-type": "individual",
- "display-name": "Company name",
- "application-status": "referred",
- "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "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",
- "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",
- "bank-product-types-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/product-types",
- "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:
path Parameters
organization-id required | string |
Responses
Response samples
- 200
{- "legal-persons": [
- {
- "individual-verifications-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
- "latest-decision": {
- "verification-url": "string",
- "decision-outcome": "accepted",
- "decision-maker": "system",
- "decision-notes": "string",
- "created-at": "2019-08-24T14:15:22Z",
- "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
- "decision-user-username": "user@example.com"
}, - "legal-person-type": "individual",
- "display-name": "string",
- "application-status": "referred",
- "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "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",
- "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",
- "bank-product-types-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/product-types",
- "legal-person-documents-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents",
- "bank-accounts-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/accounts"
}
]
}
Create legal person
Creates a new Legal Person. A collection of Claims may be provided.
Authorizations:
path Parameters
organization-id required | string |
Request Body schema: application/json
display-name required | string (display-name) non-empty |
legal-person-type required | string (legal-person-type) Enum: "individual" "corporation" |
Array of mobile-number (object) or individual-identity (object) or sole-trader (object) or uk-company-register (object) or company-telephone-number (object) or person-with-significant-control (object) or company-email-address (object) or uk-financial-services-register (object) or contact-details (object) or company-website (object) or director (object) or alternative-number (object) or (individual-residence (building-name (object) or building-number (object))) (claim) |
Responses
Request samples
- Payload
{- "display-name": "string",
- "legal-person-type": "individual",
- "claims": [
- {
- "mobile-number": "+442012345678",
- "claim-type": "mobile-number"
}
]
}
Response samples
- 201
{- "individual-verifications-url": "/v0/individuals/lp.IGxlZ2FsLXBlcnNvbi1pZA/verifications",
- "latest-decision": {
- "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
- "decision-outcome": "accepted",
- "decision-maker": "system",
- "decision-notes": "string",
- "created-at": "2019-08-24T14:15:22Z",
- "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
- "decision-user-username": "user@example.com"
}, - "legal-person-type": "individual",
- "display-name": "Company name",
- "application-status": "referred",
- "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "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",
- "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",
- "bank-product-types-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/product-types",
- "legal-person-documents-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/documents",
- "bank-accounts-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA/bank/accounts"
}
Create claim
Creates a new claim about a Legal Person.
Authorizations:
path Parameters
legal-person-id required | string |
Request Body schema: application/json
mobile-number required | string (mobile-number) (\+[1-9])?\d{1,14} |
claim-type required | string Value: "mobile-number" |
Responses
Request samples
- Payload
{- "mobile-number": "+442012345678",
- "claim-type": "mobile-number"
}
Response samples
- 201
{- "mobile-number": "+442012345678",
- "claim-type": "mobile-number"
}
List organization workflows
Lists workflows for use when creating a verification.
Authorizations:
path Parameters
organization-id required | string |
Responses
Response samples
- 200
{- "workflows": [
- {
- "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA",
- "display-name": "string",
- "legal-person-type": "individual",
- "created-at": "2019-08-24T14:15:22Z",
- "workflow-rules": [
- "allow-missing-directors"
]
}
]
}
Get workflow
Fetch the workflow.
Authorizations:
path Parameters
workflow-id required | string |
Responses
Response samples
- 200
{- "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA",
- "display-name": "string",
- "legal-person-type": "individual",
- "created-at": "2019-08-24T14:15:22Z",
- "workflow-rules": [
- "allow-missing-directors"
]
}
List verifications for a legal person
List verifications for the given legal person.
Authorizations:
path Parameters
legal-person-id required | string |
Responses
Response samples
- 200
{- "verifications": [
- {
- "created-at": "2019-08-24T14:15:22Z",
- "legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "verification-status": "in-progress",
- "verification-url": "string",
- "verification-checks-url": "string",
- "risk-rating": "high-risk",
- "updated-at": "2019-08-24T14:15:22Z",
- "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA"
}
]
}
Perform verification of a 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.
Authorizations:
path Parameters
legal-person-id required | string |
Request Body schema: application/json
workflow-url required | string (workflow-url) |
Responses
Request samples
- Payload
{- "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA"
}
Get verification
Fetch the verification.
Authorizations:
path Parameters
verification-id required | string |
Responses
Response samples
- 200
{- "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"
}
List decisions
Lists all decisions for the given legal-person.
Authorizations:
path Parameters
legal-person-id required | string |
Responses
Response samples
- 200
{- "decisions": [
- {
- "verification-url": "string",
- "decision-outcome": "accepted",
- "decision-maker": "system",
- "decision-notes": "string",
- "created-at": "2019-08-24T14:15:22Z",
- "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
- "decision-user-username": "user@example.com"
}
]
}
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:
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
- Payload
{- "verification-url": "string",
- "decision-outcome": "accepted",
- "decision-notes": "string"
}
Response samples
- 201
{- "verification-url": "string",
- "decision-outcome": "accepted",
- "decision-maker": "system",
- "decision-notes": "string",
- "created-at": "2019-08-24T14:15:22Z",
- "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
- "decision-user-username": "user@example.com"
}
Lookup company
Lookup Companies House company by company number. Includes information about the company, its directors, and persons with significant control.
Authorizations:
path Parameters
company-number required | string non-empty Example: 10842931 UK Companies House company number |
Responses
Response samples
- 200
{- "company-address": {
- "building-number": "string",
- "street-name": "string",
- "city": "string",
- "postal-code": "NW16XE",
- "country-code": "GB"
}, - "date-of-latest-accounts": "2019-08-24",
- "entity-name": "string",
- "directors": [
- {
- "display-name": "string",
- "companies-house-url": "https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX",
- "director-appointed-on": "2019-08-24",
- "director-occupation": "string",
- "day-of-birth": 1,
- "month-of-birth": 1,
- "year-of-birth": 1
}
], - "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": [
- {
- "display-name": "string",
- "natures-of-control": [
- "voting-rights-25-to-50-percent-limited-liability-partnership"
], - "companies-house-url": "https://api.company-information.service.gov.uk/company/00000001/appointments/AbcDEFGhI1JKLmnO2PQ3sTUv4WX",
- "given-name": "string",
- "surname": "string",
- "day-of-birth": 1,
- "month-of-birth": 1,
- "year-of-birth": 1
}
], - "confirmation-statement-overdue": true,
- "date-of-incorporation": "2019-08-24",
- "entity-registration-number": "string"
}
Get bank account
Fetch a bank account
Authorizations:
path Parameters
bank-account-id required | string |
Responses
Response samples
- 200
{- "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": "closing",
- "owner-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "created-at": "2019-08-24T14:15:22Z",
- "close-account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close",
- "available-balance": {
- "currency": "GBP",
- "value": "1000.00"
}, - "bank-addresses": [
- {
- "account-holder": "string",
- "bank-id": "123456",
- "account-number": "12345678"
}
], - "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": {
- "currency": "GBP",
- "value": "1000.00"
}
}
Update a bank-account
Update a bank-account
Authorizations:
path Parameters
bank-account-id required | string |
Request Body schema: application/json
display-name required | string (display-name) non-empty |
Responses
Request samples
- Payload
{- "display-name": "string"
}
Response samples
- 200
{- "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": "closing",
- "owner-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "created-at": "2019-08-24T14:15:22Z",
- "close-account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close",
- "available-balance": {
- "currency": "GBP",
- "value": "1000.00"
}, - "bank-addresses": [
- {
- "account-holder": "string",
- "bank-id": "123456",
- "account-number": "12345678"
}
], - "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": {
- "currency": "GBP",
- "value": "1000.00"
}
}
Close a bank account
Close a bank account
Authorizations:
path Parameters
bank-account-id required | string |
Responses
Response samples
- 200
{- "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": "closing",
- "owner-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "created-at": "2019-08-24T14:15:22Z",
- "close-account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close",
- "available-balance": {
- "currency": "GBP",
- "value": "1000.00"
}, - "bank-addresses": [
- {
- "account-holder": "string",
- "bank-id": "123456",
- "account-number": "12345678"
}
], - "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": {
- "currency": "GBP",
- "value": "1000.00"
}
}
List legal person bank accounts
Yields a list of bank accounts where the beneficiary is this legal person.
Authorizations:
path Parameters
legal-person-id required | string |
Responses
Response samples
- 200
{- "accounts": [
- {
- "account-payments-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments",
- "bank-product-type": "client-money-account",
- "display-name": "string",
- "controller-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "account-status": "closing",
- "owner-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "created-at": "2019-08-24T14:15:22Z",
- "close-account-url": "string",
- "available-balance": {
- "currency": "GBP",
- "value": "1000.00"
}, - "bank-addresses": [
- {
- "account-holder": "string",
- "bank-id": "123456",
- "account-number": "12345678"
}
], - "account-transactions-url": "string",
- "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA",
- "beneficiary-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "account-balance": {
- "currency": "GBP",
- "value": "1000.00"
}
}
]
}
Create bank account
POST
creates a new bank account. Yields the same as GET
to the [Bank] resource.
Authorizations:
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" "operational-account" |
display-name required | string (display-name) non-empty |
Responses
Request samples
- Payload
{- "bank-product-type": "client-money-account",
- "display-name": "string"
}
Response samples
- 201
{- "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": "closing",
- "owner-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "created-at": "2019-08-24T14:15:22Z",
- "close-account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/actions/close",
- "available-balance": {
- "currency": "GBP",
- "value": "1000.00"
}, - "bank-addresses": [
- {
- "account-holder": "string",
- "bank-id": "123456",
- "account-number": "12345678"
}
], - "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": {
- "currency": "GBP",
- "value": "1000.00"
}
}
List bank accounts
Yields a list of all bank accounts under the control of this Organization.
Authorizations:
path Parameters
organization-id required | string |
Responses
Response samples
- 200
{- "accounts": [
- {
- "account-payments-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments",
- "bank-product-type": "client-money-account",
- "display-name": "string",
- "controller-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "account-status": "closing",
- "owner-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "created-at": "2019-08-24T14:15:22Z",
- "close-account-url": "string",
- "available-balance": {
- "currency": "GBP",
- "value": "1000.00"
}, - "bank-addresses": [
- {
- "account-holder": "string",
- "bank-id": "123456",
- "account-number": "12345678"
}
], - "account-transactions-url": "string",
- "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA",
- "beneficiary-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "account-balance": {
- "currency": "GBP",
- "value": "1000.00"
}
}
]
}
List customer bank accounts
Lists all customer bank accounts under the control of this Organization.
Authorizations:
path Parameters
organization-id required | string |
Responses
Response samples
- 200
{- "accounts": [
- {
- "account-payments-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA/payments",
- "bank-product-type": "client-money-account",
- "display-name": "string",
- "controller-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "account-status": "closing",
- "owner-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "created-at": "2019-08-24T14:15:22Z",
- "close-account-url": "string",
- "available-balance": {
- "currency": "GBP",
- "value": "1000.00"
}, - "bank-addresses": [
- {
- "account-holder": "string",
- "bank-id": "123456",
- "account-number": "12345678"
}
], - "account-transactions-url": "string",
- "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA",
- "beneficiary-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "account-balance": {
- "currency": "GBP",
- "value": "1000.00"
}
}
]
}
List bank account payments
Lists payments made from a bank account.
Authorizations:
path Parameters
bank-account-id required | string |
Responses
Response samples
- 200
{- "payments": [
- {
- "payment-submission-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submission",
- "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
- "payment-status": "failed",
- "account-number": "12345678",
- "account-holder": "string",
- "payment-direction": "inbound-payment",
- "bank-id": "123456",
- "created-at": "2019-08-24T14:15:22Z",
- "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
- "payment-reference": "test reference",
- "payment-amount": {
- "currency": "GBP",
- "value": "1000.00"
}, - "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}
]
}
Create payment
Registers a new payment request for the bank account
Authorizations:
path Parameters
bank-account-id required | string |
Request Body schema: application/json
payee-url required | string (payee-url) |
required | object (money-amount) |
payment-reference | string (payment-reference) [ 1 .. 35 ] characters |
Responses
Request samples
- Payload
{- "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
- "payment-amount": {
- "currency": "GBP",
- "value": "1000.00"
}, - "payment-reference": "test reference"
}
Response samples
- 201
{- "payment-submission-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submission",
- "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
- "payment-status": "failed",
- "account-number": "12345678",
- "account-holder": "string",
- "payment-direction": "inbound-payment",
- "bank-id": "123456",
- "created-at": "2019-08-24T14:15:22Z",
- "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
- "payment-reference": "test reference",
- "payment-amount": {
- "currency": "GBP",
- "value": "1000.00"
}, - "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}
List payee payments
Lists payments made to a payee.
Authorizations:
path Parameters
payee-id required | string |
Responses
Response samples
- 200
{- "payments": [
- {
- "payment-submission-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submission",
- "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
- "payment-status": "failed",
- "account-number": "12345678",
- "account-holder": "string",
- "payment-direction": "inbound-payment",
- "bank-id": "123456",
- "created-at": "2019-08-24T14:15:22Z",
- "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
- "payment-reference": "test reference",
- "payment-amount": {
- "currency": "GBP",
- "value": "1000.00"
}, - "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}
]
}
Get payment
Yields payment details
Authorizations:
path Parameters
payment-id required | string |
Responses
Response samples
- 200
{- "payment-submission-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submission",
- "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
- "payment-status": "failed",
- "account-number": "12345678",
- "account-holder": "string",
- "payment-direction": "inbound-payment",
- "bank-id": "123456",
- "created-at": "2019-08-24T14:15:22Z",
- "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
- "payment-reference": "test reference",
- "payment-amount": {
- "currency": "GBP",
- "value": "1000.00"
}, - "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}
Submit payment
Submits an outgoing payment.
Authorizations:
path Parameters
payment-id required | string |
Responses
Response samples
- 200
{- "payment-submission-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submission",
- "payee-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA",
- "payment-status": "failed",
- "account-number": "12345678",
- "account-holder": "string",
- "payment-direction": "inbound-payment",
- "bank-id": "123456",
- "created-at": "2019-08-24T14:15:22Z",
- "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
- "payment-reference": "test reference",
- "payment-amount": {
- "currency": "GBP",
- "value": "1000.00"
}, - "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}
List transactions
Yields the list of bank account transactions.
Authorizations:
path Parameters
bank-account-id required | string |
Responses
Response samples
- 200
{- "account-transactions": [
- {
- "account-balance-change": {
- "currency": "GBP",
- "value": "1000.00"
}, - "account-balance-result": {
- "currency": "GBP",
- "value": "1000.00"
}, - "post-datetime": "2019-08-24T14:15:22Z",
- "value-datetime": "2019-08-24T14:15:22Z",
- "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA"
}
], - "account-url": "/v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA"
}
List legal person payees
Lists payees belonging to the legal person.
Authorizations:
path Parameters
legal-person-id required | string |
Responses
Response samples
- 200
{- "payees": [
- {
- "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-status": "deactivated",
- "payee-payments-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA/payments",
- "country-code": "GB"
}
]
}
Create payee
Registers a new payee for the customer
Authorizations:
path Parameters
legal-person-id required | string |
Request Body schema: application/json
account-holder required | string (account-holder) non-empty The name of the account holder. |
account-number required | string (account-number) |
bank-id required | string (bank-id) = 6 characters ^[a-zA-Z0-9]*$ |
Responses
Request samples
- Payload
{- "account-holder": "string",
- "account-number": "12345678",
- "bank-id": "123456"
}
Response samples
- 201
{- "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-status": "deactivated",
- "payee-payments-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA/payments",
- "country-code": "GB"
}
Get payee
Yields payee details
Authorizations:
path Parameters
payee-id required | string |
Responses
Response samples
- 200
{- "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-status": "deactivated",
- "payee-payments-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA/payments",
- "country-code": "GB"
}
Update payee
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.
Authorizations:
path Parameters
payee-id required | string |
Request Body schema: application/json
payee-status required | string (payee-status) Value: "deactivated" |
Responses
Request samples
- Payload
{- "payee-status": "deactivated"
}
Response samples
- 200
{- "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-status": "deactivated",
- "payee-payments-url": "/v0/payees/pe.ICAgICAgICBwYXllZS1pZA/payments",
- "country-code": "GB"
}
Get organization
Yields the organization details
Authorizations:
path Parameters
organization-id required | string |
Responses
Response samples
- 200
{- "own-legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "organization-mode": "test-mode",
- "organization-memberships-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships",
- "organization-customer-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts/customer",
- "organization-invitations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations",
- "display-name": "Company Org",
- "organization-api-keys-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys",
- "organization-live-access-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access",
- "organization-workflows-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows",
- "organization-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts",
- "available-roles": [
- {
- "display-name": "Company Org",
- "description": "string",
- "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}
], - "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"
}
Get user
Yields the User resource.
Authorizations:
path Parameters
user-id required | string |
Responses
Response samples
- 200
{- "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"
}
List membership roles
Returns a list of all roles assigned to this member of the organization.
Authorizations:
path Parameters
membership-id required | string |
Responses
Response samples
- 200
{- "roles": [
- {
- "display-name": "string",
- "description": "string",
- "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}
]
}
Update role
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
.
Authorizations:
path Parameters
membership-id required | string |
Request Body schema: application/json
role-urls required | Array of strings (role-url) |
Responses
Request samples
- Payload
{- "role-urls": [
- "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
]
}
Response samples
- 200
{- "roles": [
- {
- "display-name": "string",
- "description": "string",
- "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}
]
}
Get membership
Yields the Membership resource.
Authorizations:
path Parameters
membership-id required | string |
Responses
Response samples
- 200
{- "membership-url": "/v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA",
- "membership-roles-url": "/v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles",
- "organization": {
- "own-legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "organization-mode": "test-mode",
- "organization-memberships-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships",
- "organization-customer-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts/customer",
- "organization-invitations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations",
- "display-name": "string",
- "organization-api-keys-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys",
- "organization-live-access-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access",
- "organization-workflows-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows",
- "organization-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts",
- "available-roles": [
- {
- "display-name": "string",
- "description": "string",
- "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}
], - "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"
}, - "roles": [
- {
- "display-name": "string",
- "description": "string",
- "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}
], - "user": {
- "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"
}, - "created-at": "2019-08-24T14:15:22Z"
}
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:
path Parameters
organization-id required | string |
Responses
Response samples
- 200
{- "memberships": [
- {
- "membership-url": "/v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA",
- "membership-roles-url": "/v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles",
- "organization": {
- "own-legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "organization-mode": "test-mode",
- "organization-memberships-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships",
- "organization-customer-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts/customer",
- "organization-invitations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations",
- "display-name": "Company Org",
- "organization-api-keys-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys",
- "organization-live-access-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access",
- "organization-workflows-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows",
- "organization-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts",
- "available-roles": [
- {
- "display-name": "Company Org",
- "description": "string",
- "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}
], - "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"
}, - "roles": [
- {
- "display-name": "Company Org",
- "description": "string",
- "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}
], - "user": {
- "user-email": "user@example.com",
- "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
- "user-username": "user@example.com",
- "api-keys-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys",
- "user-memberships-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships",
- "given-name": "string",
- "surname": "string"
}, - "created-at": "2019-08-24T14:15:22Z"
}
]
}
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:
path Parameters
user-id required | string |
Responses
Response samples
- 200
{- "memberships": [
- {
- "membership-url": "/v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA",
- "membership-roles-url": "/v0/memberships/mp.ICAgbWVtYmVyc2hpcC1pZA/roles",
- "organization": {
- "own-legal-person-url": "/v0/legal-persons/lp.IGxlZ2FsLXBlcnNvbi1pZA",
- "organization-mode": "test-mode",
- "organization-memberships-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/memberships",
- "organization-customer-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts/customer",
- "organization-invitations-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/invitations",
- "display-name": "Company Org",
- "organization-api-keys-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/api-keys",
- "organization-live-access-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/live-access",
- "organization-workflows-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/workflows",
- "organization-bank-accounts-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts",
- "available-roles": [
- {
- "display-name": "Company Org",
- "description": "string",
- "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}
], - "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"
}, - "roles": [
- {
- "display-name": "Company Org",
- "description": "string",
- "role-url": "/v0/roles/re.ICAgICAgICAgcm9sZS1pZA"
}
], - "user": {
- "user-email": "user@example.com",
- "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
- "user-username": "user@example.com",
- "api-keys-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA/api-keys",
- "user-memberships-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA/memberships",
- "given-name": "string",
- "surname": "string"
}, - "created-at": "2019-08-24T14:15:22Z"
}
]
}
View and manage your API keys.
The api-key-secret
field is only shown once when created.
We cannot recover the value.
You should store it securely.
Pass an Authorization
header with GriffinAPIKey api-key-secret
to authenticate.
Get API key
Returns the API key without api-key-secret
.
Authorizations:
path Parameters
api-key-id required | string |
Responses
Response samples
- 200
{- "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",
- "created-at": "2019-08-24T14:15:22Z"
}
List API keys
List all active API keys in your organization.
Authorizations:
path Parameters
organization-id required | string |
Responses
Response samples
- 200
{- "api-keys": [
- {
- "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",
- "created-at": "2019-08-24T14:15:22Z"
}
]
}
Create API Key
Create a new API key. This is the only time api-key-secret
is shown.
Authorizations:
path Parameters
organization-id required | string |
Request Body schema: application/json
api-key-name required | string (api-key-name) non-empty The name of the API Key. Cannot contain whitespace. |
Responses
Request samples
- Payload
{- "api-key-name": "string"
}
Response samples
- 201
{- "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",
- "created-at": "2019-08-24T14:15:22Z",
- "api-key-secret": "g-test-buildserver-RrUZ5fUG4pSKwYVVG1C3Ft1xrMRxy1T7KUIyTva5bTk"
}
List API keys
List all your active API keys.
Authorizations:
path Parameters
user-id required | string |
Responses
Response samples
- 200
{- "api-keys": [
- {
- "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",
- "created-at": "2019-08-24T14:15:22Z"
}
]
}