Get an application
Use this API in your onboarding flow to fetch application data for review, auditing, or integration with internal systems.
Request
Endpoint
| environment | HTTP method | endpoint |
|---|---|---|
| Sandbox testing | GET | https://api-sandbox.flexfactor.io/v1/onboarding/application/{id} |
| Production environment | GET | https://api.flexfactor.io/v1/onboarding/application/{id} |
Required Key
| Field | Description |
|---|---|
id | The unique ID of the application returned by the submission or listing endpoints. |
bearer token | The authentication token returned by /oauth2/token for authorizing the API request. |
Response
Field Definitions
| Field Name | Field Type | Field Explanation |
|---|---|---|
id | String | The unique identifier of the application. |
status | String | The current status of the application (Draft, Submitted, In Review, Approved, etc.). |
createdOn | String | The date and time when the application was created (in ISO 8601 format). |
lastUpdatedOn | String | The date and time of the application's most recent update. |
legalEntityName | String | The legal name of the business entity. |
dba | String | The "Doing Business As" name of the entity, if applicable. |
taxId | String | The tax identification number of the business. |
descriptor | String | The billing descriptor associated with the business. |
primaryContact | Object | Object containing details of the primary contact person for the application. |
* firstName | String | First name of the primary contact. |
* lastName | String | Last name of the primary contact. |
* email | String | Email address of the primary contact. |
* phone | String | Phone number of the primary contact. |
customerSupportInfo | Object | Object containing customer support details. |
* supportLink | String | URL for the customer support website. |
* supportEmail | String | Email address for customer support. |
* supportPhone | String | Phone number for customer support. |
address | Object | Business address associated with the application. |
* addressLine1 | String | The main address line. |
* addressLine2 | String | Additional address details (e.g., suite, floor). |
* city | String | City of the business address. |
* state | String | State of the business address. |
* zipcode | String | Postal code of the business address. |
* country | String | Country of the business address. |
owners | Array of Objects | Array of owners with details about individuals with ownership in the business. |
* title | String | Title or role of the owner (e.g., Founder, CEO). |
* percentOwnership | String | Ownership percentage held by the owner. |
* idNumber | String | Identification number provided by the owner. |
bankAccountInfo | Object | Object containing bank account details for payouts. |
* bankName | String | Name of the bank. |
* accountNumber | String | Account number for the business. |
* routingNumber | String | Routing number for the bank. |
businessModel | Object | Details about the business model and operations. |
productInfo | Object | Information about the products or services offered by the business. |
volumeEstimates | Object | Estimated transaction volumes, chargebacks, and disputes for the business. |
errors | Array | Any issues or errors associated with the application processing. |
Payload Examples
Request
cURL Request Example
curl --request GET \
--url https://api-sandbox.flexfactor.io/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": []
}Updated about 20 hours ago
