AccountChek

This integration hooks into a customer's AccountChek account for validating and retrieving asset accounts and balances

Required Credentials

All AccountChek calls require the following customer credentials

{
    "username": string,
    "password": string
}

Post New Order

Endpoint

Method URI Headers
POST /api/v1/integrations/accountchek/orders {"Authorization": "Bearer {access_token}"}

Data Params

{
    //...credentials,
    "data"    : {
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "last4SSN": "string",
      "referenceNumber": "string|open string for internal identification",
      "returnUrl": "string (optional) post-enrollment landing url",
      "notificationUrl": "string (optional) client hosted site for postbacks",
      "status": "string (optional)",
      "requestType": "string (required for creating VOA and obtaining widget script) lite or full ",
      "accountMonitoring": "string (optional) refresh period",
      "expectedAccounts": "string (optional) expected borrower accounts"
    }
}

Example Response Content

{
  "data": {
    "id": "zLyyZv9dAWI3xwvlMG75ckNQpM48zjuovbmXb",
    "type": "order",
    "attributes": {
      "enrollmentWidgetScript": "<script>...</script><div>...<div>",
      "enrollmentSSOKey": "bcf93911-8d22-4f2c-8383-faefd3bea4dd",
      "created": "2018-11-13T21:45:32.103Z",
      "isArchived": false,
      "status": "closed",
      "loginUrl": "https://mobile2.accountchek.net/Account/Login?vodkey=73dcbb6b8de7e8118607000d3a112735",
      "daysRemaining": 0,
      "email": "bill@test.com",
      "last4SSN": "7777",
      "referenceNumber": "smartapp:324721:borrower",
      "firstName": "Bill",
      "lastName": "Test",
      "notificationUrl": "https://forms.lenderhomepage.com/api/v1/callback/4ce0b8de-add4-4d7f-b4c8-ef14ff1d862c/formfree?order_id=73dcbb6b-8de7-e811-8607-000d3a112735",
      "returnUrl": null,
      "phoneNumber": null,
      "employerName": null
    }
  }
}

AccountChek returns the embedable widget code which can be displayed for user's to select their bank account details. However, this process requires embedding the code in an iframe. To make this process simpler, the Integration Portal allows you to frame in this content simply by passing in the enrollmentSSOKey value like in the example below:

<iframe src="https://integrations.lenderhomepage.com/integrations/accountchek/enrollment-widget?ssoKey=[enrollmentSSOKey]" frameborder="0" style="height:600px;width:100%" height="600" width="100%"></iframe>

This makes the process of embedding in an in-page modal much simpler.

Note: the report of accounts is not immediately available once the user completes this frame. Polling will need to be done on the Get Order method passing the id from this call until the accounts have been populated.

Get All Orders

Endpoint

Method URI Headers
GET /api/v1/integrations/accountchek/orders {"Authorization": "Bearer {access_token}"}

Data Params

{
    //...credentials,
    "data"    : {
    }
}

Example Response Content

{
  "data": [
    {
      "id": "zLyyZv9dAWI3xwvlMG75ckNQpM48zjuovbmXb",
      "type": "order",
      "attributes": {
        "created": "2018-11-13T21:45:32.103Z",
        "isArchived": false,
        "status": "closed",
        "loginUrl": "https://mobile2.accountchek.net/Account/Login?vodkey=73dcbb6b8de7e8118607000d3a112735",
        "daysRemaining": 0,
        "email": "bill@test.com",
        "last4SSN": "7777",
        "referenceNumber": "smartapp:324721:borrower",
        "firstName": "Bill",
        "lastName": "Test",
        "notificationUrl": "https://forms.lenderhomepage.com/api/v1/callback/4ce0b8de-add4-4d7f-b4c8-ef14ff1d862c/formfree?order_id=73dcbb6b-8de7-e811-8607-000d3a112735",
        "returnUrl": null,
        "phoneNumber": null,
        "employerName": null
      }
    },
    {
      "id": "BXeenJ9zvBU3yNJ8LXdbcKryRo74AEFwKojxb",
      "type": "account",
      "attributes": {
      "created": "2018-11-13T21:45:32.103Z",
      "isArchived": false,
      "status": "closed",
      "loginUrl": "https://mobile2.accountchek.net/Account/Login?vodkey=73dcbb6b8de7e8118607000d3a112735",
      "daysRemaining": 0,
      "email": "jason@test.com",
      "last4SSN": "7777",
      "referenceNumber": "smartapp:324721:borrower",
      "firstName": "Jason",
      "lastName": "Test",
      "notificationUrl": "https://forms.lenderhomepage.com/api/v1/callback/4ce0b8de-add4-4d7f-b4c8-ef14ff1d862c/formfree?order_id=73dcbb6b-8de7-e811-8607-000d3a112735",
      "returnUrl": null,
      "phoneNumber": null,
      "employerName": null
      }
    }
  ]
}

Get Order

Endpoint

Method URI Headers
GET /api/v1/integrations/accountchek/orders/{orderId} {"Authorization": "Bearer {access_token}"}

Data Params

{
    //...credentials,
    "data"    : {
    }
}

Example Response Content

{
  "data": {
    "id": "zLyyZv9dAWI3xwvlMG75ckNQpM48zjuovbmXb",
    "type": "order",
    "attributes": {
      "created": "2018-11-13T21:45:32.103Z",
      "isArchived": false,
      "status": "closed",
      "loginUrl": "https://mobile2.accountchek.net/Account/Login?vodkey=73dcbb6b8de7e8118607000d3a112735",
      "daysRemaining": 0,
      "email": "bill@test.com",
      "last4SSN": "7777",
      "referenceNumber": "smartapp:324721:borrower",
      "firstName": "Bill",
      "lastName": "Test",
      "notificationUrl": "https://forms.lenderhomepage.com/api/v1/callback/4ce0b8de-add4-4d7f-b4c8-ef14ff1d862c/formfree?order_id=73dcbb6b-8de7-e811-8607-000d3a112735",
      "returnUrl": null,
      "phoneNumber": null,
      "employerName": null,
      "accounts": [
        {
          "TaggedTransactions": [],
          "accountID": "b1529885-a14f-4962-b23a-497c54b70c0f",
          "TransactionStartDate": "2019-03-20T00:00:00",
          "TransactionEndDate": "2019-04-11T00:00:00",
          "LargeDeposits": [],
          "Summary": {...},
          "CurrentBalance": 25173.54,
          "AvailableBalance": 25173.54,
          "StartingBalance": 22973.41,
          "DaysInExistence": 426,
          "DaysRequested": 90
        }
      ]
    }
  }
}