Skip to main content
POST
/
credit-applications
/
{credit_application_id}
/
additional-documents
/
confirmation
Error
A valid request URL is required to generate request examples
{
  "financial_analysis_type": "full",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "financial_documents": [
    "year_end_financial"
  ],
  "additional_documents": [
    "<string>"
  ],
  "message": "<string>",
  "additional_documents_sent": false
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

​
Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Path Parameters

​
credit_application_id
string<uuid>
required

Response

Successful Response

​
financial_analysis_type
enum<string>
required
Available options:
full,
partial,
none
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
financial_documents
enum<string>[] | null
Minimum array length: 1
Available options:
year_end_financial,
interim_financial,
bank_statement,
financial_package
​
additional_documents
string[] | null
Minimum array length: 1
​
message
string | null
Required string length: 1 - 500
​
additional_documents_sent
boolean
default:false