Skip to main content
GET
/
credit-applications
/
{credit_application_id}
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credit_application_type": "credit_terms",
  "forwarder": {
    "id": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com"
  },
  "shipper": {
    "id": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com"
  },
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "data": {
    "details": {
      "annual_revenue": 123,
      "credit_amount": 123,
      "currency": "<string>",
      "payment_terms": "<string>",
      "freight_spend": 123,
      "purpose": "<string>"
    },
    "trade_profile": {
      "shipping_routes": [
        "<string>"
      ],
      "trade_types": [
        "import"
      ],
      "avg_shipment_value": 123
    },
    "trade_profile_document": {
      "filename": "<string>"
    },
    "security_compliance": [
      {
        "title": "<string>",
        "other": true,
        "description": "<string>"
      }
    ]
  },
  "extra_details": {
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "proposed_amount": 1073741823,
    "proposed_terms": "<string>"
  }
}

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

​
id
string<uuid>
required
​
credit_application_type
enum<string>
required
Available options:
credit_terms,
trade_finance,
factoring
​
forwarder
CreditApplicationOrganization · object
required
​
shipper
CreditApplicationOrganization · object
required
​
status
enum<string>
required
Available options:
pending,
internal_review,
external_review,
needs_action,
approved,
finalized,
declined,
rejected,
expired
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
expires_at
string<date-time> | null
required
​
data
CreditTermsData · object
required
​
extra_details
RetrieveCreditApplicationPostApprovalChange · object