FinCapture User Account

FinCapture API for managing clearingworks users.

Get deposit account information

SecurityJWT
Request
Request Body schema:
fiKey
string

A unique identifier for the financial institution.

userId
string

The unique identifier for the user.

accountNumber
string

The account number associated with the user.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

412

Precondition failed

500

Internal Server Error

post/fincapture/useraccount/getDepositAccountInformation
Request samples
{
  • "fiKey": "string",
  • "userId": "string",
  • "accountNumber": "string"
}
Response samples
{
  • "accountNumber": "string",
  • "ssoKey": "string",
  • "dailyDepositLimit": "string",
  • "availableDepositLimit": "string"
}

Get user account information

SecurityJWT
Request
Request Body schema:
fiKey
string

A unique identifier for the financial institution.

isSSORequest
boolean

Indicates if the request is a Single Sign-On (SSO) request.

userId
string

The unique identifier for the user.

firstName
string

The first name of the user.

lastName
string

The last name of the user.

emailAddress
string

The email address of the user.

Array of objects (FinCaptureAPIAccount)

A list of account data objects.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

412

Precondition failed

500

Internal Server Error

post/fincapture/useraccount/getUserAccountInformation
Request samples
{
  • "fiKey": "string",
  • "isSSORequest": true,
  • "userId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailAddress": "string",
  • "accountDataList": [
    ]
}
Response samples
{
  • "accountDataList": [
    ]
}

Registers a new user for deposit access

SecurityJWT
Request
Request Body schema:
fiKey
string

A unique identifier for the financial institution.

isSSORequest
boolean

Indicates if the request is a Single Sign-On (SSO) request.

userId
string

The unique identifier for the user.

firstName
string

The first name of the user.

lastName
string

The last name of the user.

emailAddress
string

The email address of the user.

Array of objects (FinCaptureAPIAccount)

A list of account data objects.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

412

Precondition failed

500

Internal Server Error

post/fincapture/useraccount/register
Request samples
{
  • "fiKey": "string",
  • "isSSORequest": true,
  • "userId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailAddress": "string",
  • "accountDataList": [
    ]
}
Response samples
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
➔ Next to JWT Authentication