• User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

  • User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

Heartland - Dev Portal

  • folder icon closed folder iconIntroduction
  • folder icon closed folder iconAuthentication
  • folder icon closed folder iconManagement
    • Getting Started
    • Platform Accounts Management
      • Get Platform Account Configuration
      • Get Platform Account
      • Create Platform Account
      • Update Platform Account
      • Objects Reference
    • Sub-Accounts Management
      • Get Sub-Account Configurations
      • Get Sub-Account
      • Create Sub-Account
      • Update Sub-Account
      • Objects Reference
    • Users Management
      • Get User by User Id
      • Get User by Username
      • Create User
      • Update User
      • Objects Reference
    • Underwriting Management
      • Get Application
      • Get Application Template
      • Get Application Fields Statuses
      • Get Application Status
      • Get Linked Sub-Accounts
      • Get Resubmission
      • UMS IFrame Authentication
      • UMS IFrame
      • UMS IFrame Authentication in Resubmission Mode
      • UMS IFrame in Resubmission Mode
      • Create Application
      • Update Application
      • Update Application Fields Statuses
      • Update Application Status
      • Objects Reference
      • Response Codes
  • folder icon closed folder iconTransactions Processing
    • Getting Started
    • Credit Card Transactions
      • 3D-Secure
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • Recurring
    • ACH
    • Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTransactions Echo
    • Getting Started
    • Credit Card Transactions
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • ACH
    • Echo Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTokenization
    • Processing with a Token
      • Getting Started
      • Processing with Tokenization
    • Tokenization iFrame
      • iFrame Integration
      • iFrame Customization
      • iFrame Testing
      • Response Example
    • Tokenization API
      • Getting Started
      • Tokenization Request
      • Tokenization Response
      • Response Codes
  • folder icon closed folder iconPayouts
    • Getting Started
    • Payout Transactions
    • Response
    • Objects Reference
  • folder icon closed folder iconReports
    • Getting Started
    • Reports API
      • Account Balances
      • Payouts
      • Payouts Reconciliation
      • Transaction Details
      • Settlements
      • Account Summary
      • Transactions
      • Transactions Summary
      • Fees Summary
      • Incoming Fees
      • Expected Future Revenue
      • Profitability Analysis
      • Reconciliation Summary
      • Reconciliation Records
      • Chargeback Analysis
      • Tokens
      • Sign-up Summary
    • Status Codes
  • folder icon closed folder iconErrors
  • folder icon closed folder iconResponse Codes
  1. Home
  2. Docs
  3. Heartland – Dev Portal
  4. Reports
  5. Reports API
  6. Sign-up Summary
Updated on June 9, 2023

Heartland - Dev Portal

  • folder icon closed folder iconIntroduction
  • folder icon closed folder iconAuthentication
  • folder icon closed folder iconManagement
    • Getting Started
    • Platform Accounts Management
      • Get Platform Account Configuration
      • Get Platform Account
      • Create Platform Account
      • Update Platform Account
      • Objects Reference
    • Sub-Accounts Management
      • Get Sub-Account Configurations
      • Get Sub-Account
      • Create Sub-Account
      • Update Sub-Account
      • Objects Reference
    • Users Management
      • Get User by User Id
      • Get User by Username
      • Create User
      • Update User
      • Objects Reference
    • Underwriting Management
      • Get Application
      • Get Application Template
      • Get Application Fields Statuses
      • Get Application Status
      • Get Linked Sub-Accounts
      • Get Resubmission
      • UMS IFrame Authentication
      • UMS IFrame
      • UMS IFrame Authentication in Resubmission Mode
      • UMS IFrame in Resubmission Mode
      • Create Application
      • Update Application
      • Update Application Fields Statuses
      • Update Application Status
      • Objects Reference
      • Response Codes
  • folder icon closed folder iconTransactions Processing
    • Getting Started
    • Credit Card Transactions
      • 3D-Secure
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • Recurring
    • ACH
    • Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTransactions Echo
    • Getting Started
    • Credit Card Transactions
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • ACH
    • Echo Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTokenization
    • Processing with a Token
      • Getting Started
      • Processing with Tokenization
    • Tokenization iFrame
      • iFrame Integration
      • iFrame Customization
      • iFrame Testing
      • Response Example
    • Tokenization API
      • Getting Started
      • Tokenization Request
      • Tokenization Response
      • Response Codes
  • folder icon closed folder iconPayouts
    • Getting Started
    • Payout Transactions
    • Response
    • Objects Reference
  • folder icon closed folder iconReports
    • Getting Started
    • Reports API
      • Account Balances
      • Payouts
      • Payouts Reconciliation
      • Transaction Details
      • Settlements
      • Account Summary
      • Transactions
      • Transactions Summary
      • Fees Summary
      • Incoming Fees
      • Expected Future Revenue
      • Profitability Analysis
      • Reconciliation Summary
      • Reconciliation Records
      • Chargeback Analysis
      • Tokens
      • Sign-up Summary
    • Status Codes
  • folder icon closed folder iconErrors
  • folder icon closed folder iconResponse Codes

Sign-up Summary

REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/underwriting-sign-up-summary

REST Production URL: https://reports-api.4levers.com/api/Reports/underwriting-sign-up-summary

Use Sign-up Summary Report to view the UMS life cycle from an UMS application request to an active Sub-Account.

Request Example (REST Production URL)

GET: https://reports-api.4levers.com/api/Reports/underwriting-sign-up-summary?DateFrom=2019-07-23&DateTo=2019-07-24

Request Parameters

 NameTypeRequiredDescription
 datefromdatetime✓determines the selection starting/ending time range
 datetodatetime✓
 serviceprovidersinteger/arrayoptionalenter your service provider id(s)
 operatorsinteger/arrayoptionalenter your operator id(s)
 skipintegeroptional

these parameters determine which records will be displayed in the report based on specified index number.

to get from fifth to twentieth record specify skip = 4 and take = 16

 
 takeintegeroptional

Response Parameters

 NameDescription
 systemdatesystem date
 numberofapplicationsignupsoverall number of applications created in this specific date
 numberofapplicationsundervalidationoverall number of applications with status = “under validation”
 numberofapplicationsunderreviewoverall number of applications with status = “under review”
 numberofapplicationspendingresubmissionoverall number of applications with status = “pending resubmission”
 numberofdeclinedapplicationsnumber of applications declined in this date
 numberofapprovedapplicationsnumber of applications approved in this date
 numberofboardedsubaccountsoverall number of sub-accounts created in this date
 numberofactivesubaccountsoverall number of active sub-accounts in this date
 numberofdisabledsubaccountsoverall number of disabled sub-accounts in this date
 operatoroperator name
 serviceproviderservice provider name

 

				
					[
  {
    "date": "2019-10-15T00:00:00",
    "numberOfApplicationSignUps": "1",
    "numberOfApplicationsUnderValidation": "3",
    "numberOfApplicationsUnderReview": "0",
    "numberOfApplicationsPendingResubmission": "0",
    "numberOfDeclinedApplications": "0",
    "numberOfApprovedApplications": "0",
    "numberOfBoardedSubAccounts": "2",
    "numberOfActiveSubAccounts": "5",
    "numberOfDisabledSubAccounts": "2",
    "operator": "OperatorName1",
    "serviceProvider": "ServiceProviderName1"
  },
  {
    "date": "2019-10-15T00:00:00",
    "numberOfApplicationSignUps": "1",
    "numberOfApplicationsUnderValidation": "3",
    "numberOfApplicationsUnderReview": "0",
    "numberOfApplicationsPendingResubmission": "0",
    "numberOfDeclinedApplications": "0",
    "numberOfApprovedApplications": "0",
    "numberOfBoardedSubAccounts": "2",
    "numberOfActiveSubAccounts": "5",
    "numberOfDisabledSubAccounts": "2",
    "operator": "OperatorName1",
    "serviceProvider": "ServiceProviderName1"
  }
]				
			
Still stuck? How can we help?
Was this page helpful? Yes No

How can we help?

© Amaryllis Payment Solutions, 2022  All rights reserved.