Invite applicant

This endpoint allows a partner to invite a new applicant to complete the boarding form

Request
Response
Payload examples

Request

Endpoint

environment	HTTP method	endpoint
Sandbox testing	POST	https://api-sandbox.flex-charge.com/v1/onboarding/application/invite
Production environment	POST	https://api.flex-charge.com/v1/onboarding/application/invite

Required key

bearer token

The auth token returned by

/oauth2/token

body fields

The following table provides an overview of the objects and fields used in the payloads:

Object / Field	Type	Description
`LegalEntityName`	String	The registered legal name of the business.
`Dba`	String	The "Doing Business As" name, if different from the legal name.
`PrimaryContact`	Object	Details of the primary contact person for the application.
`FirstName`	String	First name of the contact person.
`LastName`	String	Last name of the contact person.
`Email`	String	Email address of the contact person.
`Phone`	String	Phone number of the contact person.

Response

Application Object

Attribute	Type	Description
`id`	String	The unique identifier of the application.
`status`	String	The current status of the application (`Draft`, `Submitted`, `Approved`).
`createdOn`	Date	The date and time the application was created.
`lastUpdatedOn`	Date	The date and time the application was last updated.
`errors`	Array	Any errors or issues encountered during processing.

Payload examples

Request

{
  "LegalEntityName": "Example Corporation",
  "Dba": "Example Corp DBA",
  "PrimaryContact": {
    "FirstName": "Alice",
    "LastName": "Smith",
    "Email": "[email protected]",
    "Phone": "+11234567890"
  }
}

{
  "LegalEntityName": "Tech Innovations Ltd.",
  "Dba": "Tech Innovators",
  "TaxId": "456789123",
  "CompanyInUS": true,
  "BusinessType": "LLC",
  "EcommercePlatform": "-",
  "EstablishedDate": "-",
  "MCC": "5045",
  "Descriptor": "TECH INNOV",
  "WebsiteUrl": "https://www.techinnovations.com",
  "Description": "-",
  "PCIDSS": null,
  "CustomerSupportInformation": {
    "Name": "Customer Support Team",
    "SupportLink": "https://support.examplecorp.com",
    "Email": "[email protected]",
    "Phone": "+10123456789"
  },
  "BankInformation": {
    "DDA": "-",
    "AccountNumber": "123456789",
    "RoutingNumber": "021000021",
    "BankName": "Example Bank"
  },
  "Address": {
    "AddressLine1": "456 Elm St",
    "AddressLine2": "Building B",
    "City": "New York",
    "Zipcode": "10001",
    "Country": "United States",
    "State": "NY"
  },
  "OwnersInformation": [
    {
      "Title": "Founder",
      "PrincipalType": "Individual",
      "FirstName": "Alice",
      "LastName": "Smith",
      "DateOfBirth": "1975-05-15",
      "Email": "[email protected]",
      "Phone": "+11234567890",
      "PercentOwnership": "100%",
      "IndividualFormOfID": "Passport",
      "IDNumber": "A12345678",
      "OwnerAddressInformation": {
        "AddressLine1": "789 Owner Lane",
        "AddressLine2": "Apt 101",
        "Country": "United States",
        "State": "NY",
        "City": "Owner City",
        "Zipcode": "67890"
      }
    }
  ],
  "BusinessModel": {
    "Industry": "Technology, Software, Electronics",
    "UrlsForFlexProcessing": [
      "https://www.examplecorp.com/shop",
      "https://checkout.examplecorp.com",
      "https://payments.examplecorp.com/transactions"
    ]
  },
  "ProductInformation": {
    "MainSourcesOfCustomerAcquisition": [
      "Paid Search",
      "Social Media",
      "Email",
      "Partnerships / Collaborations",
      "In Person Marketing"
    ],
    "MaxSubscriptionDuration": "60 Days",
    "TrialPeriod": "7-14 Days",
    "DeliveryTime": "5-7 Days",
    "ProductsSold": "Tangible",
    "RegulatedBusiness": false,
    "HealthcareRelated": false
  },
  "ContactInformation": {
    "FirstName": "Bob",
    "LastName": "Johnson",
    "Email": "[email protected]",
    "Phone": "+10987654321"
  },
  "VolumeEstimates": {
    "AverageMonthlySalesVolumes": "$100K-$500K",
    "AverageMonthlyDeclineRate": "5%-10%",
    "AverageTransactionAmount": "$100-$200",
    "AverageReturnRate": "2% - 5%",
    "AverageChargebackRate": "0.5%-1%",
    "AverageDisputeRate": "0.5%-1%"
  }
}

Response

{
  "id": "application_123456",
  "status": "success",
  "createdOn": "2024-11-15T10:30:00Z",
  "lastUpdatedOn": "2024-11-16T12:00:00Z",
  "errors": []
}

Updated 4 days ago