Get an application

This endpoint retrieves the details of a specific application identified by its unique ID ({id}). The response provides a detailed overview of the application's information, including its current status, applicant details, and submitted data.

Use this API in your onboarding flow to fetch application data for review, auditing, or integration with internal systems.






Request


Endpoint


Required Key

FieldDescription
idThe unique ID of the application returned by the submission or listing endpoints.
bearer tokenThe authentication token returned by /oauth2/token for authorizing the API request.


Response

Field Definitions

Field NameField TypeField Explanation
idStringThe unique identifier of the application.
statusStringThe current status of the application (Draft, Submitted, In Review, Approved, etc.).
createdOnStringThe date and time when the application was created (in ISO 8601 format).
lastUpdatedOnStringThe date and time of the application's most recent update.
legalEntityNameStringThe legal name of the business entity.
dbaStringThe "Doing Business As" name of the entity, if applicable.
taxIdStringThe tax identification number of the business.
descriptorStringThe billing descriptor associated with the business.
primaryContactObjectObject containing details of the primary contact person for the application.
- firstNameStringFirst name of the primary contact.
- lastNameStringLast name of the primary contact.
- emailStringEmail address of the primary contact.
- phoneStringPhone number of the primary contact.
customerSupportInfoObjectObject containing customer support details.
- supportLinkStringURL for the customer support website.
- supportEmailStringEmail address for customer support.
- supportPhoneStringPhone number for customer support.
addressObjectBusiness address associated with the application.
- addressLine1StringThe main address line.
- addressLine2StringAdditional address details (e.g., suite, floor).
- cityStringCity of the business address.
- stateStringState of the business address.
- zipcodeStringPostal code of the business address.
- countryStringCountry of the business address.
ownersArray of ObjectsArray of owners with details about individuals with ownership in the business.
- titleStringTitle or role of the owner (e.g., Founder, CEO).
- percentOwnershipStringOwnership percentage held by the owner.
- idNumberStringIdentification number provided by the owner.
bankAccountInfoObjectObject containing bank account details for payouts.
- bankNameStringName of the bank.
- accountNumberStringAccount number for the business.
- routingNumberStringRouting number for the bank.
businessModelObjectDetails about the business model and operations.
productInfoObjectInformation about the products or services offered by the business.
volumeEstimatesObjectEstimated transaction volumes, chargebacks, and disputes for the business.
errorsArrayAny issues or errors associated with the application processing.

Payload Examples

Request

cURL Request Example

curl --request GET \
     --url https://api-sandbox.flex-charge.com/v1/application/{id} \
     --header 'Authorization: bearer {the token returned by /oauth2}' \
     --header 'accept: application/json'



Response

Example for a Retrieved Application

{
  "id": "application_123456",
  "status": "Submitted",
  "createdOn": "2024-11-15T10:30:00Z",
  "lastUpdatedOn": "2024-11-16T12:00:00Z",
  "legalEntityName": "Tech Innovations Ltd.",
  "dba": "Tech Innovators",
  "taxId": "987654321",
  "descriptor": "TECHINNOV",
  "primaryContact": {
    "firstName": "Alice",
    "lastName": "Smith",
    "email": "[email protected]",
    "phone": "+11234567890"
  },
  "customerSupportInfo": {
    "supportLink": "https://support.techinnovators.com",
    "supportEmail": "[email protected]",
    "supportPhone": "+10123456789"
  },
  "address": {
    "addressLine1": "456 Elm St",
    "addressLine2": "Building B",
    "city": "New York",
    "state": "NY",
    "zipcode": "10001",
    "country": "United States"
  },
  "owners": [
    {
      "title": "Founder",
      "percentOwnership": "100%",
      "idNumber": "A12345678"
    }
  ],
  "bankAccountInfo": {
    "bankName": "Example Bank",
    "accountNumber": "123456789",
    "routingNumber": "021000021"
  },
  "businessModel": {
    "industry": "Technology, Software, Electronics"
  },
  "productInfo": {
    "productsSold": "Tangible"
  },
  "volumeEstimates": {
    "averageMonthlySalesVolume": "$100K-$500K",
    "averageTransactionAmount": "$100-$200"
  },
  "errors": []
}