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

200

{
  "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"
}

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

200

application/json

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

id · 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. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"