Get Application
Use GET Underwriting Application method to inquire an existing underwriting application
- In the request URL user enters
{id}of the existing underwriting application - In the response user receives a Json object with application fields with values
https://sandbox.4levers.com/managementapi/api/underwriting-applications/{applicationId}
Production: https://managementapi.4levers.com/api/underwriting-applications/{applicationId}
Response Parameters
| Name | Type | Description | ||||||||
| id | string | Application identifier. | ||||||||
| payoutStatus | enum | Application status:
Available Values:
|
||||||||
| signUpdate | datetime | |||||||||
| approvalDeclineDate | datetime | |||||||||
| resubmissionDate | datetime | |||||||||
| modificationDate | datetime | |||||||||
| name | string | Application name. | ||||||||
| templateId | string | Application template identifier. | ||||||||
| contactEmail | string | Notification target email. |
Application Body Object
| Name | Type | Description |
| businessDetails | object | Business details include business general information. |
| businessDetailsDocuments | object | Business details documents include business registration documents. |
| bankingDetails | object | Banking details include business bank and bank account information. |
| bankingDetailsDocuments | object | Banking details documents include business banking documents. |
| contactDetails | array | Contact details include business contact information. |
| ownerDetails | array | Owner details include business owner information. |
| businessProfile | object | Business profile includes information about the nature of a business |
| businessProfileDocuments | object | Business profile documents include pci compliance certificate. |
| businessFinancials | object | Business financials include business payment cards processing projections. |
| businessProcessingHistory | object | Business processing history includes historical data about payment card processing. |
| businessProcessingHistory | object | business processing history includes historical data about payment card processing. |
https://sandbox.4levers.com/managementapi/api/underwriting-applications/{applicationId}
Response
{
"id": 0,
"status": "Approved",
"signUpDate": "2022-05-16T12:00:28.810Z",
"modificationDate": "2022-05-16T12:00:28.810Z",
"resubmissionDate": "2022-05-16T12:00:28.810Z",
"approvalDeclineDate": "2022-05-16T12:00:28.810Z",
"name": "string",
"templateId": 0,
"contactEmail": "string",
"applicationBody": {
"businessDetails": {
"name": "string",
"legalName": "string",
"registrationNumber": "string",
"ownershipType": "Individual",
"taxId": "string",
"giin": "string",
"incorporationDate": "2022-05-16T12:00:28.810Z",
"businessAddress": {
"street": "string",
"apartment": "string",
"city": "string",
"country": "string",
"stateCode": "string",
"zip": "string"
},
"corporateAddress": {
"street": "string",
"apartment": "string",
"city": "string",
"country": "string",
"stateCode": "string",
"zip": "string"
},
"companyWebsiteUrl": "string",
"dbaName": "string",
"dbaWebsiteUrl": "string",
"dynamicDescriptor": "string",
"description": "string",
"customerServicePhone": "string",
"customerServiceEmail": "string",
"fax": "string",
"socialMediaAccounts": [
{
"socialNetwork": "Facebook",
"accountName": "string"
}
],
"agreement": true,
"customField1": "string",
"customField2": "string",
"customField3": "string",
"phoneNumber": "string",
"emailAddressForNotices": "string",
"numberOfLocations": 0,
"numberOfOutlets": 0
},
"businessDetailsDocuments": {
"registrationCertificate": {
"fileName": "string",
"fileBody": "string"
},
"proofOfAddress": {
"fileName": "string",
"fileBody": "string"
},
"customDocument1": {
"fileName": "string",
"fileBody": "string"
},
"customDocument2": {
"fileName": "string",
"fileBody": "string"
},
"customDocument3": {
"fileName": "string",
"fileBody": "string"
},
"articleOfIncorporation": {
"fileName": "string",
"fileBody": "string"
}
},
"bankingDetails": {
"bankAccount": {
"accountNumber": "string",
"accountType": "Checking",
"accountHolderName": "string",
"entityType": "Personal",
"routingNumber": "string",
"bankName": "string"
},
"plaidAccessToken": "string",
"billingAddress": {
"country": "US",
"stateCode": "NY",
"apartment":"25, 90503"
"street": "667 Madison Avenue, Upper East Side",
"city": "New York",
"zip": "10065"
}
},
"bankingDetailsDocuments": {
"voidCheck": {
"fileName": "string",
"fileBody": "string"
},
"customDocument1": {
"fileName": "string",
"fileBody": "string"
},
"customDocument2": {
"fileName": "string",
"fileBody": "string"
},
"customDocument3": {
"fileName": "string",
"fileBody": "string"
}
},
"contactDetails": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contactType": "Statements",
"firstName": "string",
"lastName": "string",
"legalName": "string",
"email": "string",
"mobilePhone": "string",
"homePhone": "string",
"address": {
"street": "string",
"apartment": "string",
"city": "string",
"country": "string",
"stateCode": "string",
"zip": "string"
},
"customField1": "string",
"customField2": "string",
"customField3": "string"
}
],
"ownerDetails": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"firstName": "string",
"lastName": "string",
"idNumber": "string",
"giin": "string",
"email": "string",
"mobilePhone": "string",
"homePhone": "string",
"address": {
"street": "string",
"apartment": "string",
"city": "string",
"country": "string",
"stateCode": "string",
"zip": "string"
},
"dateOfBirth": "2022-05-16T12:00:28.810Z",
"position": "string",
"citizenship": "string",
"ownershipDate": "2022-05-16T12:00:28.810Z",
"ownershipPercentage": 0,
"driversLicenceNumber": "string",
"driversLicenceCountry": "string",
"driversLicenceState": "string",
"customField1": "string",
"customField2": "string",
"customField3": "string",
"controlProng": true,
"ownerDetailsDocuments": {
"proofOfId": {
"fileName": "string",
"fileBody": "string"
},
"proofOfAddress": {
"fileName": "string",
"fileBody": "string"
},
"personalGuarantee": {
"fileName": "string",
"fileBody": "string"
},
"customDocument1": {
"fileName": "string",
"fileBody": "string"
},
"customDocument2": {
"fileName": "string",
"fileBody": "string"
},
"customDocument3": {
"fileName": "string",
"fileBody": "string"
},
"driversLicenseFront": {
"fileName": "string",
"fileBody": "string"
},
"driversLicenseBack": {
"fileName": "string",
"fileBody": "string"
}
}
}
],
"businessProfile": {
"industry": "InformationTechnology",
"category": "Retail",
"privacyPolicyUrl": "string",
"returnsPolicyUrl": "string",
"tcPolicyUrl": "string",
"gstExempt": true,
"gstNumber": "string",
"descriptionOfGoods": "string",
"saleChannels": [
{
"channelType": "string",
"percentageOfSales": 0
}
],
"shipping": {
"shippingRequired": true,
"inventory": true,
"deliveryTimePercentage": {
"oneToSevenDays": 0,
"eightToFourteenDays": 0,
"fifteenToThirtyDays": 0,
"moreThanThirtyDays": 0
}
},
"pciCompliance": {
"isEnabled": true,
"pciLevel": "DssLevelOne",
"storesSensitiveData": true,
"dataCompromised": true
},
"customField1": "string",
"customField2": "string",
"customField3": "string",
"mccCode": "string",
"seasonalBusiness": true,
"seasonalBusinessMonths": ["January"],
"processingMethods": {
"deviceTerminal": 0,
"moTo": 0,
"online": 0
},
"merchantBillingType": "Debit",
"merchantPricingModel": "DailyDiscount"
},
"businessProfileDocuments": {
"pciCertificate": {
"fileName": "string",
"fileBody": "string"
},
"customDocument1": {
"fileName": "string",
"fileBody": "string"
},
"customDocument2": {
"fileName": "string",
"fileBody": "string"
},
"customDocument3": {
"fileName": "string",
"fileBody": "string"
}
},
"businessFinancials": {
"volumeProjection": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"avgTicketPriceProjection": "string",
"customField1": "string",
"customField2": "string",
"customField3": "string",
"annualVolumeProjection": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"monthlyVolumeProjection": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"highestTicketPriceProjection": "string",
"isAnnualAmexVolumeExceedMillionDollars": true
},
"businessProcessingHistory": {
"volumeHistory": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"avgTicketPriceHistory": "string",
"previousBankruptcy": true,
"customField1": "string",
"customField2": "string",
"customField3": "string",
"monthlyVolumeHistory": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"annualVolumeHistory": {
"visa": "string",
"mastercard": "string",
"americanExpress": "string",
"localDebitCard": "string",
"discover": "string"
},
"highestTicketPriceHistory": "string",
"previousPersonalBankruptcy": true
}
}
}