Skip to main content
POST
/
applications
Create an application
curl --request POST \
  --url https://api.synctera.com/v2/applications \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
  "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"
}
'
{
  "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"
}

Body

application/json

Application model.

​
account_type
enum<string>
required

Account type of Application

Available options:
LINE_OF_CREDIT,
CHARGE_SECURED,
CHARGE_UNSECURED
Example:

"LINE_OF_CREDIT"

​
applicants
Applicant details · object[]
required
Minimum array length: 1
​
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"

​
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"

Response

Application created.

​
account_type
enum<string>
required

Account type of Application

Available options:
LINE_OF_CREDIT,
CHARGE_SECURED,
CHARGE_UNSECURED
Example:

"LINE_OF_CREDIT"

​
applicants
Applicant details · object[]
required
Minimum array length: 1
​
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

Application creation timestamp in RFC3339 format

​
id
string<uuid>
required

Generated ID for the application

​
last_updated_time
string<date-time>
required

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"