Skip to main content
POST
/
applications
Create an application
curl --request POST \
  --url https://api.synctera.com/v1/applications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "account_type": "LINE_OF_CREDIT",
  "applicants": [
    {
      "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",
      "is_primary": true,
      "underwriting_data": [
        {
          "request_time": "2023-11-07T05:31:56Z",
          "vendor": "PLAID",
          "vendor_info": {}
        }
      ]
    }
  ],
  "application_submitted_time": "2023-01-13T23:59:59Z",
  "credit_decision_time": "2023-01-13T23:59:59Z",
  "customer_response_time": "2023-01-13T23:59:59Z",
  "purpose": "ACCOUNT_OPENING",
  "status": "CREDIT_ACCEPTED_BY_CUSTOMER",
  "type": "CREDIT"
}'
{
  "account_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "applicant": {
    "business": {
      "annual_revenue": 123,
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "personal": {
      "employment": {
        "employer_name": "<string>",
        "employment_start_date": "2023-12-25",
        "income": 123,
        "position": "<string>"
      },
      "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "type": "business"
  },
  "application_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attributes": {},
  "metadata": {
    "entity_id": "<string>",
    "tenant": "<string>",
    "version": "<string>"
  },
  "provider": "loanpro",
  "requested_credit_limit": 123,
  "tenant": "abcdef_ghijkl",
  "type": "CREDIT",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "application_submitted_time": "2023-11-07T05:31:56Z",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creation_time": "2023-11-07T05:31:56Z",
  "credit_limit": 123,
  "credit_report": {},
  "customer_type": "business",
  "decision": "approved",
  "decision_time": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "interest_rate": 123,
  "last_updated_time": "2023-11-07T05:31:56Z",
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rejection_reasons": [
    "<string>"
  ],
  "status": "completed",
  "vendor_response": {
    "execution_id": "<string>",
    "raw_response": {},
    "vendor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Application model.

  • Credit application details
  • Line of Credit application details
  • Restricted account application details
​
account_type
enum<string>
required

Account type of Application

Available options:
CHARGE_SECURED,
CHARGE_UNSECURED,
LINE_OF_CREDIT
Example:

"LINE_OF_CREDIT"

​
applicants
Applicant details · object[]
required
Minimum length: 1
​
purpose
enum<string>
required

Purpose of the credit application.

Available options:
ACCOUNT_OPENING,
APR_REDUCTION,
HARDSHIP,
LINE_INCREASE_REQUEST
​
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:
CREDIT_ACCEPTED_BY_CUSTOMER,
CREDIT_APPROVED,
CREDIT_DENIED,
CREDIT_NOT_ACCEPTED_BY_CUSTOMER,
SUBMITTED
​
type
enum<string>
required

Type of Application

Available options:
CREDIT,
LOC,
RESTRICTED_ACCOUNT
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"

Response

Application created.

  • Line of Credit application response
  • Restricted account application details
  • Credit application details
​
account_template_id
string<uuid>
required

Mainapi account template ID to use for creating the LOC account

​
applicant
object
required
​
application_workflow_id
string<uuid>
required

ID of the workflow to use for processing

​
provider
enum<string>
required

Provider for LOC application

Available options:
loanpro
​
tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

​
type
enum<string>
required

Type of Application

Available options:
CREDIT,
LOC,
RESTRICTED_ACCOUNT
Example:

"CREDIT"

​
creation_time
string<date-time>
required

Application creation timestamp in RFC3339 format

​
customer_type
enum<string>
required

Type of applicant

Available options:
business,
personal
​
id
string<uuid>
required

Application ID

​
last_updated_time
string<date-time>
required

Timestamp of the last application modification in RFC3339 format

​
status
enum<string>
required

Status of the LOC application

Available options:
completed,
error,
pending,
processing
​
attributes
object

Raw JSON key-value pairs for flexible data

​
metadata
object
​
requested_credit_limit
integer

Requested credit limit in cents (e.g., 250000000 = $2,500,000)

​
account_id
string<uuid>

Account ID created for approved application

​
application_submitted_time
string<date-time>

Application submitted timestamp in RFC3339 format

​
business_id
string<uuid>

Business ID if customer_type is business

​
credit_limit
integer

Credit limit in cents (e.g., 250000000 = $2,500,000)

​
credit_report
object

Credit report data object

​
decision
enum<string>

Credit decision for LOC application

Available options:
approved,
declined,
pending,
review
​
decision_time
string<date-time>

Decision timestamp in RFC3339 format

​
external_id
string

External identifier (e.g., Taktile decision_id)

​
interest_rate
integer

Interest rate in basis points (e.g., 1250 = 12.50%)

​
person_id
string<uuid>

Person ID if customer_type is personal

​
rejection_reasons
string[]
​
vendor_response
object