Modify an application

🚧 Beta This is an Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint.

Modify an existing application for an account.

PATCH /applications/{application_id}

Modify an application

cURL

curl --request PATCH \
  --url https://api.synctera.com/v1/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": {}
        }
      ]
    }
  ]
}
'

200

{
  "account_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "applicant": {
    "type": "business",
    "business": {
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "annual_revenue": 123
    },
    "personal": {
      "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "employment": {
        "employer_name": "<string>",
        "employment_start_date": "2023-12-25",
        "income": 123,
        "position": "<string>"
      }
    }
  },
  "provider": "loanpro",
  "tenant": "abcdef_ghijkl",
  "type": "CREDIT",
  "application_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creation_time": "2023-11-07T05:31:56Z",
  "customer_type": "business",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_updated_time": "2023-11-07T05:31:56Z",
  "status": "completed",
  "attributes": {},
  "metadata": {
    "entity_id": "<string>",
    "tenant": "<string>",
    "version": "<string>"
  },
  "requested_credit_limit": 123,
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "application_submitted_time": "2023-11-07T05:31:56Z",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credit_limit": 123,
  "credit_report": {},
  "decision": "approved",
  "decision_time": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "interest_rate": 123,
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rejection_reasons": [
    "<string>"
  ],
  "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.

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

Credit card application patch

Line of Credit 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: CREDIT_ACCEPTED_BY_CUSTOMER, CREDIT_APPROVED, CREDIT_DENIED, CREDIT_NOT_ACCEPTED_BY_CUSTOMER, SUBMITTED

Response

200

application/json

Updated application.

Line of Credit application response

Credit card 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

Show child attributes

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, CREDIT_CARD, LOC, RESTRICTED_ACCOUNT

Example:

"CREDIT"

application_workflow_id · string<uuid> · required

ID of the workflow used for processing. Obtained from the account template.

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

Show child attributes

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

Show child attributes