PATCH
/
applications
/
{application_id}
Modify an application
curl --request PATCH \
  --url https://api.synctera.com/v1/applications/{application_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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": {}
        }
      ]
    }
  ],
  "status": "CREDIT_ACCEPTED_BY_CUSTOMER"
}'
{
  "application_details": {
    "sections": [
      {
        "fintech_section_id": "<string>",
        "pages": [
          {
            "fintech_page_id": "<string>",
            "items": [
              {
                "answer": "<string>",
                "fintech_item_id": "<string>",
                "question": "<string>",
                "type": "DOCUMENT"
              }
            ],
            "title": "<string>"
          }
        ],
        "title": "<string>"
      }
    ]
  },
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "description": "<string>",
  "status": "APPROVED",
  "type": "CREDIT",
  "creation_time": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_updated_time": "2023-11-07T05:31:56Z"
}

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.

​
applicants
Applicant details · object[]
​
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

Updated application.

​
application_details
object
required

Details about the restricted account application

​
status
enum<string>
required

Status of the restricted account application. APPROVED and DENIED are terminal status.

Available options:
APPROVED,
DENIED,
IN_PROGRESS,
REVIEW_INFO_REQUESTED,
REVIEW_ON_SYNCTERA,
SUBMITTED
​
type
enum<string>
required

Type of Application

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

​
business_id
string<uuid>

Business ID for the application. An application must have either a Business or a customer associated with it.

Example:

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

​
customer_id
string<uuid>

Customer ID for the application. An application must have either a Business or a customer associated with it.

Example:

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

​
description
string

A description of the restricted account application