API docs by Redocly

incuto API (2.1.0)

Download OpenAPI specification:

License: CC0

incuto's OpenAPI-compatible documentation for making credit union, CDFI, and payment related requests.

All requests must be POST and include an API key in the Authorization header, unless otherwise specified.

Organisation

Credit Union/CDFI-level Requests

List

Retrieve a list of matching API-enabled organisation details from member information supplied.

Authorizations:
Bearer
Request Body schema: application/application/x-www-form-urlencoded
required
One of
mobile
required
string <mobile>

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Settings

Retrieve the organisation settings for a Credit Union.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": {},
  • "error": "true",
  • "success": true
}

Authentication

Pre/Post Authentication Requests

Member: Generate 2FA

Generate a two-factor authentication code for the member.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
required
One of
2fa-gen
string
Enum: "email" "text"

2FA sending method

forename
required
string

Member forename

username
required
string

Member number

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

User: Generate 2FA

Generate a two-factor authentication code for the user.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
required
username
required
string

User username, typically email address

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Login

Login to the API as a Member or User.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
One of
username
required
string

Typically member number/email address

password
required
string

Member password

Responses

Response samples

Content type
application/json
Example
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Logout

Logout the currently logged in user/member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
true

Heartbeat

Refresh the login session while the end user is actively using the application.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Security

Security-related Requests

Verify Token

Verify an id and token provided by the end-user, you typically do not have to implement this.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
verify
required
string

Token to verify

id
required
string

Member/User's LoginEID

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Get incuto's Public Key

Retrieve incuto's Public Key to verify data authenticity.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Faster Payments

Direct Faster Payments API

Get Balance

Get Faster Payment Account Balance

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
accountId
required
string

ClearBank Account ID

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Get Statement

Get the ClearBank statement for a Faster Payments account.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
accountId
required
string

ClearBank Account ID

startDate
required
string <date>

Start date

endDate
required
string <date>

End date

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Submit Transaction

Submit Faster Payment Transaction

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
One of
accountId
required
string

ClearBank Account ID

accountNumber
required
string

ClearBank Account Number

sortCode
required
string

ClearBank Sort Code

accountHolderName
required
string

ClearBank Account Holder Name

reference
required
string

Transaction Reference

amount
required
number

Transaction Amount

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Credit Reference

Direct Credit Reference API

Perform Check

Perform a credit reference check against the provided data. Requires an IP-locked API Key

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
One of
data
object

Request data

Responses

Response samples

Content type
application/json
{
  • "content": { },
  • "error": "true",
  • "success": true
}

Member/User

Shared Member/User Requests

Get Last Login

Get the last login date/time for the currently logged in Member/User.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
format
string or null

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Set Password

Update the currently logged in Member/User's password.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
password
string

New password

password-confirm
string

Confirmation of new password

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Member

Member-specific Requests

Get Details

Retrieve the details of the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Get Products

Retrieve the total product balances by type for the logged in member.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
pending
integer

Whether to include pending balances

description
string

Filter to specific product descriptions

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Get Product Type

Retrieve the total product balance for the logged in member.

Authorizations:
Bearer
path Parameters
type
required
string
Enum: "savings" "loan" "credit"

Type of balance to retrieve

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Get Contents

Retrieve the logged in member's messages and documents.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
type
string

Filter to content type: 'message' or 'document'

read
integer
Deprecated

Whether to include read messages

deleted
integer
Deprecated

Whether to include deleted messages

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Get Content By EID

Get the content of a specific ContentHistory record belonging to the logged in member.

Authorizations:
Bearer
path Parameters
ContentHistoryEID
required
string

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Read Content

Retrieve a specific ContentHistory record belonging to the logged in member.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
ContentHistoryEID
required
string

ContentHistoryEID of the content to read

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Conversation Reply

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
contentHistoryEID
required
string

ContentHistoryEID of the content to reply to

message
required
string

Message to reply with

subject
string

Subject of the reply

Responses

Response samples

Content type
application/json
{
  • "content": { },
  • "error": "true",
  • "success": true
}

Get Conversation

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
contentHistoryEID
required
string

ContentHistoryEID of the content to get the conversation for

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Delete Content

Delete a specific ContentHistory record belonging to the logged in member.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
ContentHistoryEID
required
string

ContentHistoryEID of the content to delete

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Update Details

Update the logged in member's profile details.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
2fa
required
string

Verification 2FA code

MobileNumber
string

New mobile number

HomePhoneNumber
string

New home phone number

EmailAddress
string

New email address

HomeAddressLine1
string

New home address line 1

HomeAddressLine2
string

New home address line 2

HomeAddressLine3
string

New home address line 3

HomeAddressLine4
string

New home address line 4

HomeAddressLine5
string

New home address line 5

HomeAddressPostCode
string

New home address post code

Responses

Response samples

Content type
application/json
{
  • "content": "Details Updated",
  • "error": "true",
  • "success": true
}

Get Distributions

Get the payment distributions for the logged in member.

Authorizations:
Bearer

Responses

Response samples

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

Update Distribution

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
PaymentDistributionEID
required
string

PaymentDistributionEID of the payment distribution to update

NewAmount
required
string

New amount

Responses

Response samples

Content type
application/json
{
  • "content": "success",
  • "error": "true",
  • "success": true
}

Confirm Payee

Confirm a payee stand-alone from a transaction

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
PayeeAccountNumber
string

Payee account number

PayeeSortCode
string

Payee sort code

PayeeName
string

Payee name

Responses

Response samples

Content type
application/json
{
  • "AccountName": "string",
  • "Status": "match",
  • "LookupCoPStatusEID": "string",
  • "RuleInvalid": true,
  • "RuleMessage": "string",
  • "StatusName": "string",
  • "StatusMessage": "string",
  • "StatusClass": "string",
  • "RequestEID": "string"
}

Get Is Junior

Get whether the member is classified as a junior based on their age.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Get Alerts Preference

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "Email",
  • "error": "true",
  • "success": true
}

Get Analysis

Get the computed analysis figures for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "property": { },
  • "exists": true
}

Get Secured Savings

Get the secured savings for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Has Active Accounts

Check whether the member has any active accounts.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Get Registration

Get the member's registration information

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Get Loan Applications

Get the loan applications for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Get Previous Names

Get the previous names for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Get Accounts

Get the accounts for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Get Member Contacts

Get the member contacts for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Get Old Addresses

Get the old addresses for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Get Payment Frequency

Get the payment frequency details for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Get Member Payments

Get the monthly member payments for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Get Loan Payments

Get the current monthly loan payments for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Get Savings Accounts

Get the savings accounts for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": { },
  • "error": "true",
  • "success": true
}

Is Birthday Today

Check whether the member's birthday is today.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Get Member Birth Country

Get the member's birth country.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "United Kingdom",
  • "error": "true",
  • "success": true
}

Get Beneficiaries

Get the beneficiaries for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Get Common Bonds

Get the common bonds for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Get Payroll Number

Get the payroll number for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Get Age

Get the age for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Is Pending

Check whether the member is pending.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Get Title

Get the title for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Is Withdrawal Allowed

Check whether the member is allowed to withdraw.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Is Loan Apply Allowed

Check whether the member is allowed to apply for a loan.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Get Join Date Time

Get the join date time for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Contact CU

Contact the CU for the logged in member's account.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
message
string

Message to send

Responses

Response samples

Content type
application/json
{
  • "content": { },
  • "error": "true",
  • "success": true
}

247 Link

Get a link to 24/7 for the logged in member.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Is Active

Check whether the member is allowed to login.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Is Activated

Check whether the member is activated.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Member Accounts

Member Account-specific Requests

Get Available Withdrawal

Get the available withdrawal amount for the logged in member's account.

Authorizations:
Bearer
path Parameters
index
required
string

Index of the account to use

Responses

Response samples

Content type
application/json
{
  • "content": { },
  • "error": "true",
  • "success": true
}

Withdraw

Withdraw from the logged in member's account.

Authorizations:
Bearer
path Parameters
index
required
string

Index of the account to use

Request Body schema: application/x-www-form-urlencoded
One of
value
required
string

Value to withdraw

PayeeName
string

Payee name

sort-code
required
string

Sort code

account-no
required
string

Account number

2fa
required
string

Two-factor authentication code

Reference
string

Reference of the withdrawal

SavePayee
integer

Whether to save the payee

Responses

Response samples

Content type
application/json
Example
true

Get Transactions

Get the transactions for the logged in member's account.

Authorizations:
Bearer
path Parameters
index
required
string

Index of the account to use

Request Body schema: application/x-www-form-urlencoded
limit
integer

Limit of the transactions to return

offset
integer

Offset of the transactions to return

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Get Balance

Get the balance for the logged in member's account.

Authorizations:
Bearer
path Parameters
index
required
string

Index of the account to use

Request Body schema: application/x-www-form-urlencoded
pending
integer

Whether to include pending balances

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Get Product

Get the product for the logged in member's account.

Authorizations:
Bearer
path Parameters
index
required
string

Index of the account to use

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "error": "true",
  • "success": true
}

Get Settlement Amount

Get the settlement amount for the logged in member's account.

Authorizations:
Bearer
path Parameters
index
required
string

Index of the account to use

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "error": "true",
  • "success": true
}

Summary

Get the summary for the logged in member's accounts.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "error": "true",
  • "success": true
}

Transfer

Transfer from the logged in member's account.

Authorizations:
Bearer
Request Body schema: application/x-www-form-urlencoded
Amount
required
string

Amount

FromAccountNumber
required
string

From Account Number

ToMemberNumber
string

To Member Number

ToAccountNumber
required
string

To Account Number

Responses

Response samples

Content type
application/json
{
  • "content": { },
  • "error": "true",
  • "success": true
}

User

User-specific Requests

Get Role

Get the role for the logged in user.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": { },
  • "error": "true",
  • "success": true
}

Get Permissions

Get the permissions for the logged in user.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": { },
  • "error": "true",
  • "success": true
}

Is Active

Check whether the user is allowed to login.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Is Activated

Check whether the user is activated.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "content": true,
  • "error": "true",
  • "success": true
}

Webhooks

incuto's Outbound Webhooks

Faster Payment Webhook

Faster Payment webhook to receive notifications from the API.

Authorizations:
Bearer
path Parameters
fasterPaymentWebhook
required
string

Your Webhook URL

Responses

Response samples

Content type
application/json
{
  • "transactionID": 0,
  • "status": "TransactionSettled",
  • "isReturn": true,
  • "error": "true"
}