List applications

curl --request GET \
  --url https://api.synctera.com/v2/applications \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v2/applications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.synctera.com/v2/applications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synctera.com/v2/applications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/applications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "applications": [
    {
      "account_type": "LINE_OF_CREDIT",
      "applicants": [
        {
          "is_primary": true,
          "adverse_action_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "credit_score_ids": [
            "7d943c51-e4ff-4e57-9558-08cab6b963c7"
          ],
          "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "underwriting_data": [
            {
              "request_time": "2023-11-07T05:31:56Z",
              "vendor": "PLAID",
              "vendor_info": {}
            }
          ]
        }
      ],
      "purpose": "ACCOUNT_OPENING",
      "status": "SUBMITTED",
      "type": "CREDIT",
      "creation_time": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_updated_time": "2023-11-07T05:31:56Z",
      "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "application_submitted_time": "2023-01-13T23:59:59Z",
      "credit_decision_time": "2023-01-13T23:59:59Z",
      "customer_response_time": "2023-01-13T23:59:59Z",
      "tenant": "abcdef_ghijkl"
    }
  ],
  "next_page_token": "a8937a0d"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

GET

applications

List applications

curl --request GET \
  --url https://api.synctera.com/v2/applications \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v2/applications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.synctera.com/v2/applications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synctera.com/v2/applications"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/applications")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "applications": [
    {
      "account_type": "LINE_OF_CREDIT",
      "applicants": [
        {
          "is_primary": true,
          "adverse_action_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "credit_score_ids": [
            "7d943c51-e4ff-4e57-9558-08cab6b963c7"
          ],
          "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "underwriting_data": [
            {
              "request_time": "2023-11-07T05:31:56Z",
              "vendor": "PLAID",
              "vendor_info": {}
            }
          ]
        }
      ],
      "purpose": "ACCOUNT_OPENING",
      "status": "SUBMITTED",
      "type": "CREDIT",
      "creation_time": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_updated_time": "2023-11-07T05:31:56Z",
      "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "application_submitted_time": "2023-01-13T23:59:59Z",
      "credit_decision_time": "2023-01-13T23:59:59Z",
      "customer_response_time": "2023-01-13T23:59:59Z",
      "tenant": "abcdef_ghijkl"
    }
  ],
  "next_page_token": "a8937a0d"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "missing required fields: first_name, dob",
  "status": 400,
  "title": "Bad Request Body",
  "type": "https://dev.synctera.com/errors/bad-request-body"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id

string<uuid>[]

A list of customer unique identifiers, with a comma separating any values.

The unique identifier of a customer

business_id

string<uuid>[]

A list of business unique identifiers, with a comma separating any values.

The unique identifier of a business

status

enum<string>

Application status values for all types of applications

Available options:

APPROVED,

CREDIT_ACCEPTED_BY_CUSTOMER,

CREDIT_APPROVED,

CREDIT_DENIED,

CREDIT_NOT_ACCEPTED_BY_CUSTOMER,

DENIED,

IN_PROGRESS,

REVIEW_INFO_REQUESTED,

REVIEW_ON_SYNCTERA,

SUBMITTED

limit

integer

default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1

Example:

100

page_token

string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

type

enum<string>

Type of application

The type of the application to require.

CREDIT: Credit application
LINE_OF_CREDIT: (Deprecated) Line of credit application (if provided, this will be converted to a CREDIT type in the response)
RESTRICTED_ACCOUNT: restricted account application

Available options:

CREDIT,

LINE_OF_CREDIT,

RESTRICTED_ACCOUNT

sort_by

string

Optional sort by query parameter. The direction is delimited by ':' and multiple sort fields are delimited by ','

Example:

"account_id:desc,name:asc"

Response

List of applications.

applications

(Credit application details · object | Restricted account application details · object | Line of Credit application response · object | Credit card application response · object)[]

required

Array of applications.

Credit application details
Restricted account application details
Line of Credit application response
Credit card application response

Show child attributes

next_page_token

string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

List applications

Authorizations

Query Parameters

Response