Modify an application

curl --request PATCH \
  --url https://api.synctera.com/v2/applications/{application_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": {}
        }
      ]
    }
  ]
}
'

import requests

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

payload = { "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": {}
                }
            ]
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {}}]
      }
    ]
  })
};

fetch('https://api.synctera.com/v2/applications/{application_id}', 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/{application_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
                                                                                                                                
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"applicants\": [\n    {\n      \"is_primary\": true,\n      \"adverse_action_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"credit_score_ids\": [\n        \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n      ],\n      \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"underwriting_data\": [\n        {\n          \"request_time\": \"2023-11-07T05:31:56Z\",\n          \"vendor\": \"PLAID\",\n          \"vendor_info\": {}\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.synctera.com/v2/applications/{application_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"applicants\": [\n    {\n      \"is_primary\": true,\n      \"adverse_action_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"credit_score_ids\": [\n        \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n      ],\n      \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"underwriting_data\": [\n        {\n          \"request_time\": \"2023-11-07T05:31:56Z\",\n          \"vendor\": \"PLAID\",\n          \"vendor_info\": {}\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"applicants\": [\n    {\n      \"is_primary\": true,\n      \"adverse_action_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"credit_score_ids\": [\n        \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n      ],\n      \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"underwriting_data\": [\n        {\n          \"request_time\": \"2023-11-07T05:31:56Z\",\n          \"vendor\": \"PLAID\",\n          \"vendor_info\": {}\n        }\n      ]\n    }\n  ]\n}"

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

{
  "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": {}
        }
      ]
    }
  ],
  "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"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

PATCH

applications

{application_id}

Modify an application

curl --request PATCH \
  --url https://api.synctera.com/v2/applications/{application_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": {}
        }
      ]
    }
  ]
}
'

import requests

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

payload = { "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": {}
                }
            ]
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {}}]
      }
    ]
  })
};

fetch('https://api.synctera.com/v2/applications/{application_id}', 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/{application_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
                                                                                                                                
                                                                ]
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"applicants\": [\n    {\n      \"is_primary\": true,\n      \"adverse_action_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"credit_score_ids\": [\n        \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n      ],\n      \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"underwriting_data\": [\n        {\n          \"request_time\": \"2023-11-07T05:31:56Z\",\n          \"vendor\": \"PLAID\",\n          \"vendor_info\": {}\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.synctera.com/v2/applications/{application_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"applicants\": [\n    {\n      \"is_primary\": true,\n      \"adverse_action_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"credit_score_ids\": [\n        \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n      ],\n      \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"underwriting_data\": [\n        {\n          \"request_time\": \"2023-11-07T05:31:56Z\",\n          \"vendor\": \"PLAID\",\n          \"vendor_info\": {}\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"applicants\": [\n    {\n      \"is_primary\": true,\n      \"adverse_action_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"credit_score_ids\": [\n        \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n      ],\n      \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n      \"underwriting_data\": [\n        {\n          \"request_time\": \"2023-11-07T05:31:56Z\",\n          \"vendor\": \"PLAID\",\n          \"vendor_info\": {}\n        }\n      ]\n    }\n  ]\n}"

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

{
  "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": {}
        }
      ]
    }
  ],
  "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"
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

Authorizations

Authorization

string

header

required

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

Path Parameters

application_id

string<uuid>

required

Unique identifier for the application.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Application fields to be patched.

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

applicants

Applicant details · object[]

Show child attributes

status

enum<string>

Status of the credit application. CREDIT_DENIED, CREDIT_NOT_ACCEPTED_BY_CUSTOMER and CREDIT_ACCEPTED_BY_CUSTOMER are terminal status

Available options:

SUBMITTED,

CREDIT_APPROVED,

CREDIT_DENIED,

CREDIT_NOT_ACCEPTED_BY_CUSTOMER,

CREDIT_ACCEPTED_BY_CUSTOMER

Response

Updated application.

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

account_type

enum<string>

required

Account type of Application

Available options:

LINE_OF_CREDIT,

CHARGE_SECURED,

CHARGE_UNSECURED,

CREDIT_CARD

Example:

"LINE_OF_CREDIT"

applicants

Applicant details · object[]

required

Minimum array length: 1

Show child attributes

purpose

enum<string>

required

Purpose of the credit application.

Available options:

ACCOUNT_OPENING,

LINE_INCREASE_REQUEST,

APR_REDUCTION,

HARDSHIP

status

enum<string>

required

Status of the credit application. CREDIT_DENIED, CREDIT_NOT_ACCEPTED_BY_CUSTOMER and CREDIT_ACCEPTED_BY_CUSTOMER are terminal status

Available options:

SUBMITTED,

CREDIT_APPROVED,

CREDIT_DENIED,

CREDIT_NOT_ACCEPTED_BY_CUSTOMER,

CREDIT_ACCEPTED_BY_CUSTOMER

type

enum<string>

required

Type of Application

Available options:

CREDIT,

RESTRICTED_ACCOUNT,

LOC,

CREDIT_CARD

Example:

"CREDIT"

creation_time

string<date-time>

required

read-only

Application creation timestamp in RFC3339 format

string<uuid>

required

read-only

Generated ID for the application

last_updated_time

string<date-time>

required

read-only

Timestamp of the last application modification in RFC3339 format

account_id

string<uuid>

Account ID for the application. Only required if application purpose is not ACCOUNT_OPENING

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

application_submitted_time

string<date-time>

Application submitted timestamp in RFC3339 format

Example:

"2023-01-13T23:59:59Z"

credit_decision_time

string<date-time>

Credit decision timestamp in RFC3339 format

Example:

"2023-01-13T23:59:59Z"

customer_response_time

string<date-time>

Credit decision timestamp in RFC3339 format

Example:

"2023-01-13T23:59:59Z"

tenant

string

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

⌘I

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Modify an application

Authorizations

Path Parameters

Body

Response