This page differs depending on which API version you are browsing at the moment.

API changes

  • message field from error response was renamed to error_message:

{
    "error_class":   "LoginNotFound",
    "error_message": "Login with id: '1234' was not found.",
    "request":       {}
}
  • Max value of Expires-At header is 1 hour from now, in UTC timezone, otherwise ExpiresAtInvalid error will be returned.

  • A new stage, fetch_holder_info, has been added. This stage specifies that currently the information about the account holder is being fetched. You will have to contact us in order to receive this stage.

{
  "data": [
    {
      "name":"United Kingdom",
      "code": "GB"
    }
  ]
}
{
  "data": [
    {
      "name": "United Arab Emirates dirham",
      "code": "AED"
    },
    {
      "name": "Afghan afghani",
      "code": "AFN"
    }
  ]
}
{
  "data": {
    "id":         1234,
    "identifier": "test@mail.com",
    "secret":     "generatedsecret"
  }
}
{
  "data": [
    {
      "id":         1234,
      "identifier": "test@mail.com",
      "secret":     "generatedsecret"
    },
    {
      "id":         1235,
      "identifier": "tes2t@mail.com",
      "secret":     "generatedsecret2"
    },
  ]
}
{
  "data": {
    "country_code": "GB",
    "created_at": "2014-10-24T20:09:02Z",
    "customer_id": 905,
    "id": 1227,
    "last_attempt": {
        "api_version": "3",
        "automatic_fetch": true,
        "categorize": true,
        "created_at": "2016-02-02T16:14:53Z",
        "custom_fields": {},
        "device_type": "desktop",
        "remote_ip": "93.184.216.34",
        "exclude_accounts": [],
        "fail_at": null,
        "fail_error_class": null,
        "fail_message": null,
        "fetch_type": "recent",
        "finished": true,
        "finished_recent": true,
        "from_date": null,
        "id": 425036,
        "interactive": false,
        "partial": false,
        "store_credentials": true,
        "success_at": "2016-02-02T16:16:19Z",
        "to_date": null,
        "updated_at": "2016-02-02T16:16:19Z",
        "last_stage": {
          "created_at": "2016-02-02T16:16:19Z",
          "id": 2691802,
          "interactive_fields_names": null,
          "interactive_html": null,
          "name": "finish",
          "updated_at": "2016-02-02T16:16:19Z"
        }
    },
    "last_success_at": "2016-02-02T16:16:19Z",
    "next_refresh_possible_at": "2016-02-02T17:16:19Z",
    "provider_code": "barclays_gb",
    "provider_name": "Barclays",
    "status": "active",
    "updated_at": "2016-02-04T09:41:23Z"
  }
}
{
    "error_class": "LoginCannotBeRefreshed",
    "message": "Login cannot be refreshed.",
    "next_refresh_possible_at": "2016-01-29T09:38:07Z",
    "request": {
      "data": {
          "api_version": "3"
      },
      "id": "997675202"
    }
}
  • On login create of a file provider, a URL of uploaded file can be sent inside of params:

{
  "data": {
    "customer_id": 112241,
    "country_code": "XO",
    "provider_code": "mint_csv_xo",
    "fetch_type": "recent",
    "file_url": "http://spatialkeydocs.s3.amazonaws.com/FL_insurance_sample.csv"
  }
}
{
  "data":
    {
      "token": "generatedtoken",
      "expires_at": "2013-06-05T07:06:00Z",
      "connect_url": "http://saltedge.com/connect?token=generatedtoken"
    }
}
{
  "data":
    {
      "token": "generatedtoken",
      "expires_at": "2013-06-05T07:06:00Z",
      "redirect_url": "http://saltedge.com/api/v3/oauth_providers/redirect?token=generatedtoken"
    }
}
{
  "data": [
    {
      "api_version": "3",
      "automatic_fetch": true,
      "categorize": true,
      "created_at": "2015-12-25T12:12:36Z",
      "custom_fields": {},
      "device_type": "desktop",
      "remote_ip": "93.184.216.34",
      "exclude_accounts": [],
      "fail_at": null,
      "fail_error_class": null,
      "fail_message": null,
      "fetch_type": "recent",
      "finished": true,
      "finished_recent": true,
      "from_date": null,
      "id": 337518,
      "interactive": false,
      "partial": false,
      "store_credentials": true,
      "success_at": "2015-12-25T12:13:39Z",
      "to_date": null,
      "updated_at": "2015-12-25T12:13:39Z",
      "last_stage": {
        "created_at": "2015-12-25T12:13:39Z",
        "id": 2094640,
        "interactive_fields_names": null,
        "interactive_html": null,
        "name": "finish",
        "updated_at": "2015-12-25T12:13:39Z"
      }
    }
  ],
  "meta": {
    "next_id": 36154,
    "next_page": "/api/v3/attempts?from_id=36154&login_id=47872"
  }
}
{
    "data": {
      "api_version": "3",
      "automatic_fetch": true,
      "categorize": true,
      "created_at": "2016-01-28T13:40:16Z",
      "custom_fields": {},
      "device_type": "desktop",
      "remote_ip": "93.184.216.34",
      "exclude_accounts": [],
      "fail_at": null,
      "fail_error_class": null,
      "fail_message": null,
      "fetch_type": "recent",
      "finished": true,
      "finished_recent": true,
      "from_date": null,
      "id": 3355,
      "interactive": false,
      "partial": false,
      "stages": [
          {
              "created_at": "2016-01-28T13:40:16Z",
              "id": 17675,
              "interactive_fields_names": [],
              "interactive_html": null,
              "name": "start",
              "updated_at": "2016-01-28T13:40:16Z"
          },
          {
              "created_at": "2016-01-28T13:40:16Z",
              "id": 17676,
              "interactive_fields_names": null,
              "interactive_html": null,
              "name": "start",
              "updated_at": "2016-01-28T13:40:16Z"
          },
          {
              "created_at": "2016-01-28T13:40:16Z",
              "id": 17677,
              "interactive_fields_names": null,
              "interactive_html": null,
              "name": "connect",
              "updated_at": "2016-01-28T13:40:16Z"
          },
          {
              "created_at": "2016-01-28T13:40:18Z",
              "id": 17678,
              "interactive_fields_names": null,
              "interactive_html": null,
              "name": "fetch_holder_info",
              "updated_at": "2016-01-28T13:40:19Z"
          },
          {
              "created_at": "2016-01-28T13:40:19Z",
              "id": 17678,
              "interactive_fields_names": null,
              "interactive_html": null,
              "name": "fetch_accounts",
              "updated_at": "2016-01-28T13:40:19Z"
          },
          {
              "created_at": "2016-01-28T13:40:22Z",
              "id": 17679,
              "interactive_fields_names": null,
              "interactive_html": null,
              "name": "fetch_recent",
              "updated_at": "2016-01-28T13:40:22Z"
          },
          {
              "created_at": "2016-01-28T13:40:26Z",
              "id": 17680,
              "interactive_fields_names": null,
              "interactive_html": null,
              "name": "disconnect",
              "updated_at": "2016-01-28T13:40:26Z"
          },
          {
              "created_at": "2016-01-28T13:40:26Z",
              "id": 17681,
              "interactive_fields_names": null,
              "interactive_html": null,
              "name": "finish",
              "updated_at": "2016-01-28T13:40:26Z"
          }
      ],
      "store_credentials": true,
      "success_at": "2016-01-28T13:40:26Z",
      "to_date": null,
      "updated_at": "2016-01-28T13:40:26Z"
    }
}

API Callbacks

In this section examples of the new version of incoming callbacks are shown.

Success

{
  "data": {
    "login_id":      123,
    "customer_id":   3452345,
    "custom_fields": { "key": "value" }
  },
  "meta": {
    "version": "3",
    "time":    "2015-12-31T10:08:11Z"
  }
}

Failure

{
  "data": {
    "login_id":      123,
    "customer_id":   3452345,
    "custom_fields": { "key": "value" },
    "error_class":   "InvalidCredentials",
    "error_message": "Invalid credentials."
  },
  "meta": {
    "version": "3",
    "time":    "2015-12-31T10:08:11Z"
  }
}

Interactive

{
  "data": {
    "login_id":                 123,
    "customer_id":              3452345,
    "custom_fields":            { "key": "value" },
    "stage":                    "interactive",
    "html":                     "<div id='interactive'>text</div>",
    "session_expires_at":       "2015-12-30T11:08:11Z",
    "interactive_fields_names": ["image"]
  },
  "meta": {
    "version": "3",
    "time":    "2015-12-30T10:08:11Z"
  }
}

Notify

{
  "data": {
    "login_id":      123,
    "customer_id":   3452345,
    "custom_fields": { "key": "value" },
    "stage":         "start"
  },
  "meta": {
    "version": "3",
    "time":    "2015-12-30T10:08:11Z"
  }
}

Destroy

{
  "data": {
    "login_id":    123,
    "customer_id": 3452345
  },
  "meta": {
    "version": "3",
    "time":    "2013-05-17T14:29:35Z"
  }
}

New errors