1. SEAdmin Swagger
SEAdmin & SCS Docs
  • Introduction
  • SCS APIs
    • 01 Authentication Updates
    • 02 Endpoints
    • 03 Get Rates API
    • 04 Get Trims By VIN API
    • 05 Get Lienholders API
    • 06 Generate Contract API
    • 07 Contract Void API
    • 08 Contract Info API
    • 09 Print Contract PDF API
    • 10 Print Generate Contract PDF API
    • 11 Update Contract API
    • 12 Reject Contract API
    • 13 Cancel Contract API
    • 14 Submit Remittance API
    • 15 Validate Generate Contract API
    • 16 Activate Contract API
    • 17 PureFI Claim API and Contract API (REST)
  • SEA APIs
    • Common API Docs
      • API Access
      • Managing Users
      • Introduction
      • Idp API
        • createToken
    • SEA REST APIs
      • Introduction
      • Audiences
      • Digital Retailing
      • ADMIN Users API
      • SEAdmin Swagger
        • GenericAccountHolders_GetAccountHolders
          GET
        • GenericAccountHolders_PostAccountHolderStatementRequest
          POST
        • GenericAccountHolders_PostAutoExpireRequest
          POST
        • AdminCompanies_GetGeneralSettingById
          GET
        • Agents_GetAgents
          GET
        • Agents_AddAgent
          POST
        • Agents_GetAgentById
          GET
        • Agents_UpdateAgent
          PATCH
        • Agents_GetCustomFields
          GET
        • Agents_AddCustomField
          POST
        • Agents_GetCustomFieldById
          GET
        • Agents_DeleteCustomField
          DELETE
        • Agents_UpdateCustomField
          PATCH
        • AutomaticProcessRuns_Search
          GET
        • AutomaticProcessRuns_Add
          POST
        • AutomaticProcessRuns_GetByGuid
          GET
        • AutomaticProcessRuns_Update
          PATCH
        • AvailablePaymentMethods_GetAvailablePaymentMethods
          GET
        • AvailablePaymentMethods_SaveAvailablePaymentMethod
          POST
        • AvailablePaymentMethods_DeleteAvailablePaymentMethod
          DELETE
        • AvailablePaymentMethods_SaveAllAvailablePaymentMethods
          POST
        • CancelMethods_GetCancelMethods
          GET
        • CancelMethods_GetCancelMethodById
          GET
        • CancelReasons_GetCancelReasons
          GET
        • CancelReasons_GetCancelReasonById
          GET
        • CancelRequests_GetCancelRequestById
          GET
        • CancelRequests_ExecuteCancelRequest
          POST
        • CancelRequests_GetCancelPaymentDetailsByCancelRequestId
          GET
        • Cancels_GetCancelById
          GET
        • Cancels_CreateCancelRequest
          POST
        • Cancels_GetCancelPaymentDetailsByCancelId
          GET
        • CashTransaction_GetCashTransactionSearch
          GET
        • CashTransaction_AddCashTransaction
          POST
        • CashTransaction_GetCashTransactionById
          GET
        • CashTransaction_PatchCashTransaction
          PATCH
        • CashTransaction_GetCustomFields
          GET
        • CashTransaction_AddCustomField
          POST
        • CashTransaction_GetCustomFieldById
          GET
        • CashTransaction_DeleteCustomField
          DELETE
        • CashTransaction_UpdateCustomField
          PATCH
        • ClaimPayees_GetClaimPayees
          GET
        • ClaimPayees_AddClaimPayee
          POST
        • ClaimPayees_GetClaimPayeeById
          GET
        • ClaimPayees_UpdateClaimPayee
          PATCH
        • Claims_GetClaimsSearch
          GET
        • Claims_Post
          POST
        • Claims_GetClaimById
          GET
        • Claims_Put
          PUT
        • Claims_PatchClaim
          PATCH
        • Claims_GetClaimBenefits
          GET
        • Claims_GetClaimDocumentsForGapClaim
          GET
        • Claims_addClaimDocument
          POST
        • Claims_GetDocumentByGuid
          GET
        • Claims_PostClaimInspectionFile
          POST
        • Claims_AddInspection
          POST
        • Claims_UpdateInspection
          PUT
        • Claims_TakeRejectInspection
          POST
        • ClaimNotes_Post
          POST
        • ClaimNotes_Get
          GET
        • ClaimNotes_GetAllNotesForClaim
          GET
        • Claims_PostPaymentRequest
          POST
        • Claims_GetPpmServices
          GET
        • Claims_GetCauses
          GET
        • Claims_GetComplaintsCausesCorrections
          GET
        • Claims_GetComplaints
          GET
        • Claims_GetComplaintsCausesCorrectionsTypes
          GET
        • Claims_GetCorrections
          GET
        • Claims_GetClaimDeniedReasons
          GET
        • Claims_GetClaimHoldReasons
          GET
        • Claims_GetInspections
          GET
        • Claims_GetClaimInspectionById
          GET
        • Inspection_SyncInspection
          PATCH
        • Inspection_SyncPostPutInspection
          PUT
        • Contracts_GetContracts
          GET
        • Contracts_Post
          POST
        • Contracts_GetContractById
          GET
        • Contracts_PatchContract
          PATCH
        • Contracts_GetCancelPaymentDetailsByContractId
          GET
        • Contracts_GetCancelRequest
          GET
        • Contracts_CreateCancelRequest
          POST
        • Contracts_GetCancels
          GET
        • Contracts_CancelContract
          POST
        • ContractCobuyer_AddCobuyer
          POST
        • ContractCobuyer_DeleteCobuyer
          DELETE
        • Contracts_GetCoverageComponents
          GET
        • Contracts_GetCoverageGroups
          GET
        • Contracts_GetDocuments
          GET
        • Contracts_GenerateDocument
          POST
        • Contracts_GetContractEarningDetailsById
          GET
        • Contracts_GetContractFiles
          GET
        • Contracts_AddContractFile
          POST
        • Contracts_GetContractFileByGuid
          GET
        • Contracts_FinalizeContract
          POST
        • Contracts_GetHolds
          GET
        • Contracts_CreateHold
          POST
        • Contracts_GetResolvesForHold
          GET
        • Contracts_CreateResolve
          POST
        • Contracts_GetExistingContractLock
          GET
        • Contracts_ObtainContractLock
          POST
        • Contracts_ReleaseContractLock
          DELETE
        • Contracts_GetPpmServices
          GET
        • Contracts_RecalculateContractPurchaseSalesTax
          GET
        • Contracts_ReFinalizeContract
          POST
        • Contracts_RerateContract
          POST
        • Contracts_UpdateEarnings
          POST
        • Contracts_PostContractTransfer
          POST
        • Contracts_GetDuplicateGAPContracts
          GET
        • Contracts_AutoCancelGAPContract
          POST
        • Contracts_GetAutoExpireContractIds
          GET
        • Contracts_AutoExpireContract
          POST
        • Contracts_GetAutoVoidableContractIds
          GET
        • Contracts_AutoVoidContract
          POST
        • Contracts_DenyClaims
          POST
        • Contracts_GetHoldReasons
          GET
        • Contracts_UpdateEarnings
          POST
        • Customers_GetCustomers
          GET
        • Customers_GetCustomerById
          GET
        • Customers_UpdateCustomer
          PATCH
        • DealerGroups_GetDealerGroups
          GET
        • DealerGroups_AddDealerGroup
          POST
        • DealerGroups_GetDealerGroupById
          GET
        • DealerGroups_UpdateDealerGroup
          PATCH
        • DealerGroups_GetCustomFields
          GET
        • DealerGroups_AddCustomField
          POST
        • DealerGroups_GetCustomFieldById
          GET
        • DealerGroups_DeleteCustomField
          DELETE
        • DealerGroups_UpdateCustomField
          PATCH
        • Dealers_GetDealers
          GET
        • Dealers_AddDealer
          POST
        • Dealers_GetDealerById
          GET
        • Dealers_UpdateDealer
          PATCH
        • Dealers_GetCustomFields
          GET
        • Dealers_AddCustomField
          POST
        • Dealers_GetCustomFieldById
          GET
        • Dealers_DeleteCustomField
          DELETE
        • Dealers_UpdateCustomField
          PATCH
        • Dealers_GetDealerRateVisibilities
          GET
        • Dealers_GetDealersRateVisibilities
          GET
        • DisbursementAccounts_GetDisbursementAccounts
          GET
        • DisbursementAccounts_AddDisbursementAccount
          POST
        • DisbursementAccounts_GetDisbursementAccountById
          GET
        • DisbursementAccounts_UpdateDisbursementAccount
          PATCH
        • Documents_GetDocumentById
          GET
        • FactorTable_GetFactorTable
          GET
        • Files_GetFileById
          GET
        • GeneralSettings_GetGeneralSettings
          GET
        • GeneralSettings_GetGeneralSettingById
          GET
        • GeneralSettings_GetGeneralSettingGroups
          GET
        • GeneralSettings_GetGeneralSettingTypes
          GET
        • InProcessCashTransaction_GetInProcessCashTransactionSearch
          GET
        • InProcessCashTransaction_PostInProcessCashTransaction
          POST
        • InProcessCashTransaction_GetInProcessCashTransactionById
          GET
        • InProcessCashTransaction_DeleteInProcessCashTransaction
          DELETE
        • InProcessCashTransaction_ProcessInProcessCashTransaction
          POST
        • InspectionCompanies_GetInspectionCompanies
          GET
        • InspectionCompanies_AddInspectionCompany
          POST
        • InspectionCompanies_GetInspectionCompanyById
          GET
        • InspectionCompanies_UpdateInspectionCompany
          PATCH
        • Inspection_GetClaimInspectionReasons
          GET
        • Insurers_GetInsurers
          GET
        • Insurers_AddInsurer
          POST
        • Insurers_GetInsurerById
          GET
        • Insurers_UpdateInsurer
          PATCH
        • Ledgers_GetLedgersSearch
          GET
        • Ledgers_GetPayReceiveLedgers
          GET
        • Ledgers_ListUnpaidAccountingLedgerProducts
          GET
        • Ledgers_GetLedgerSummary
          GET
        • LienHolder_GetLienHolders
          GET
        • LienHolder_AddLienHolder
          POST
        • LienHolder_GetLienHolderById
          GET
        • LienHolder_UpdateLienHolder
          PATCH
        • MembershipGroups_Get
          GET
        • MembershipGroups_GetGroupsByIdOrName
          GET
        • MembershipRoles_Get
          GET
        • MembershipRoles_GetRolessByIdOrNameOrCategory
          GET
        • PortalVisibilityGroups_GetPortalVisibilityGroups
          GET
        • PortalVisibilityGroups_AddPortalVisibilityGroup
          POST
        • PortalVisibilityGroups_UpdatePortalVisibilityGroup
          PATCH
        • PortalVisibilityGroups_GetPortalVisibilityGroupById
          GET
        • PortalVisibilityGroups_DeletePortalVisibilityGroup
          DELETE
        • PortalVisibilityGroups_GetPortalVisibilityGroupDealers
          GET
        • PortalVisibilityGroups_GetPortalVisibilityGroupByCode
          GET
        • PortalVisibilityGroups_GetPortalVisibilityGroupDealersByCode
          GET
        • Rates_GetAssetTypes
          GET
        • Evaluates the provided criteria string based on the CriteriaRule grammar.
          POST
        • Rates_GetDeductiblesByProduct
          GET
        • Rates_GetDisbursementById
          GET
        • Rates_PatchDisbursementById
          PATCH
        • Rates_GetDisbursementByAccountHolder
          GET
        • Rates_AddDisbursementByAccountHolder
          POST
        • Rates_GetDisbursementAuditLogById
          GET
        • Rates_GetDisbursementCodes
          GET
        • Rates_GetDisbursementGroups
          GET
        • Rates_GetDisbursementLabels
          GET
        • Rates_GetPlans
          GET
        • Rates_GetProducts
          GET
        • Rates_GetPrograms
          GET
        • Rates_GetRateQuote
          GET
        • Rates_GetTermsPlanById
          GET
        • Rates_GetVehicleBodyStyles
          GET
        • Rates_GetVehicleMakes
          GET
        • Rates_GetVehicleModels
          GET
        • Rates_GetVehicleSegmentations
          GET
        • Rates_GetVehicleSeries
          GET
        • Rates_GetVehicleTrims
          GET
        • Inspection_GetClaimRejectInspectionReasons
          GET
        • RepairFacilities_GetRepairFacilities
          GET
        • RepairFacilities_AddRepairFacility
          POST
        • RepairFacilities_GetRepairFacilityById
          GET
        • RepairFacilities_UpdateRepairFacility
          PATCH
        • RepairFacilities_GetDealerGroupsOfRepairFacility
          GET
        • RepairFacilities_RemoveDealerGroupsFromRepairFacility
          DELETE
        • RepairFacilities_AddDealerGroupsToRepairFacility
          PATCH
        • RepairFacilities_GetDealersOfRepairFacility
          GET
        • RepairFacilities_RemoveDealersFromRepairFacility
          DELETE
        • RepairFacilities_AddDealersToRepairFacility
          PATCH
        • RepairFacilities_GetAssociatedRepairFacility
          GET
        • SalesTaxCalculation_GetSalesTaxDetails
          POST
        • Users_GetUsers
          GET
        • Users_Post
          POST
        • Users_Get
          GET
        • Users_Put
          PUT
        • CancelMethods_GetCancelMethodsV2
          GET
        • CancelMethods_GetCancelMethodByGuid
          GET
        • CancelReasons_GetCancelReasonsV2
          GET
        • CancelReasons_GetCancelReasonByGuid
          GET
        • CancelRequests_GetCancelRequestByGuid
          GET
        • CancelRequests_ExecuteCancelRequest
          POST
        • CancelRequests_GetCancelPaymentDetailsByCancelRequestId
          GET
        • CashTransaction_GetCashTransactionSearchV2
          GET
        • Contracts_GetContractsV2
          GET
        • Contracts_GetContractByGuid
          GET
        • Contracts_GetCancelPaymentDetailsByContractById
          GET
        • Contracts_GetCancelRequest
          GET
        • Contracts_CreateCancelRequest
          POST
        • LienHolder_GetLienHoldersV2
          GET
        • UsersV2_GetUsers
          GET
        • UsersV2_Post
          POST
        • UsersV2_Get
          GET
        • UsersV2_Put
          PUT
    • SEA Menu Integration Service
      • 04 Request Flow
      • 05 Samples
      • 02 Authentication Updates
      • 03 Endpoints
      • 01 Introduction
  • Schemas
    • AccessToken
    • ARCHService.Api.DTOs.Address
    • Contracts_ReleaseContractLockContractlockid
    • adminapi_ContractSearchResult
    • enterpriserepairorderapi_DMSTypes
    • Cancel Method
    • Cancel Reason
    • Create Contract Cancellation Request
    • Contract
    • Document
    • Refund Payment Details
    • Create Refund Quote Request
    • seainspections_Widget
    • AuthenticatorConfiguration
    • ARCHService.Api.DTOs.AuditLogResponse
    • Agents_UpdateAgentEditdata
    • adminapi_PaginationMetadata
    • enterpriserepairorderapi_DmsDealer
    • Cancel Method Paged Result
    • Cancel Reason Paged Result
    • Cancellation Request Response
    • Contract Summary
    • Unique Identifier
    • Refund Payment
    • Refund Quote
    • seainspections_BadRequest
    • TOTPAlgorithm
    • ARCHService.Api.DTOs.ClassDetail
    • RepairFacilities_AddDealerGroupsToRepairFacilityDealergroupids
    • adminapi_PagedContractSearchResult
    • enterpriserepairorderapi_DmsDealerConfig
    • Unique Identifier
    • Unique Identifier
    • cancellations_BadRequest
    • Contract Summary Paged Result
    • Document Name
    • Unique Identifier
    • Refund Quote Paged Result
    • seainspections_NotFound
    • TwoFactorMethod
    • ARCHService.Api.DTOs.ContractRate
    • adminapi_ErrorResponse
    • enterpriserepairorderapi_DmsDealerSearchResult
    • Date/Time
    • Cancel Reason Code
    • cancellations_NotFound
    • VIN
    • Date/Time
    • Contract Number
    • Unique Identifier
    • OAuthError
    • ARCHService.Api.DTOs.Deductible
    • adminapi_Address
    • Description
    • Description
    • Unique Identifier
    • Last Name
    • documents_BadRequest
    • Contract Status
    • Odometer Reading
    • OAuthErrorReason
    • ARCHService.Api.DTOs.DeductibleResponse
    • adminapi_Person
    • Is Deleted
    • cancelreasons_BadRequest
    • Date/Time
    • documents_NotFound
    • Money
    • Date/Time
    • OAuthErrorType
    • ARCHService.Api.DTOs.Disbursement
    • adminapi_Vehicle
    • cancelmethods_BadRequest
    • cancelreasons_NotFound
    • Unique Identifier
    • documents_Deprecated
    • Number
    • Cancel Reason
    • TokenType
    • ARCHService.Api.DTOs.DisbursementCodeResponse
    • adminapi_CreateContractRequest
    • cancelmethods_NotFound
    • Contract Status
    • documents_ServerError
    • Date/Time
    • Cancel Method
    • ARCHService.Api.DTOs.DisbursementGroupResponse
    • adminapi_CustomField
    • contracts_ProductType
    • Payee Type
    • Contract
    • ARCHService.Api.DTOs.DisbursementLabelResponse
    • adminapi_Resolve
    • Product Code
    • refundpayments_BadRequest
    • Retail Cost
    • ARCHService.Api.DTOs.FileInfo
    • adminapi_Hold
    • Product Name
    • refundpayments_NotFound
    • Non-Refundable Fee
    • ARCHService.Api.DTOs.GetDeductiblesResponseResult
    • adminapi_Program
    • Plan Code
    • Cancellation Fee
    • ARCHService.Api.DTOs.GetPlanResponseResult
    • adminapi_Product
    • Plan Name
    • Net Refund From Admin
    • ARCHService.Api.DTOs.MembershipGroup
    • adminapi_Plan
    • Term Months
    • Net Refund From Dealer
    • ARCHService.Api.DTOs.MembershipRole
    • adminapi_PDF
    • Term Miles
    • Cancel Refund Amount
    • ARCHService.Api.DTOs.Plan
    • adminapi_AdminCompany
    • Retail Cost
    • Cancel Factor Term Percent
    • ARCHService.Api.DTOs.PlanResponse
    • adminapi_Contract
    • Odometer Expiration
    • Cancel Factor Mileage Percent
    • ARCHService.Api.DTOs.PPMService
    • adminapi_UpdateContractRequest
    • contracts_Vehicle
    • Cancel Factor Percent
    • ARCHService.Api.DTOs.PPMServiceData
    • adminapi_ContractRerateResponse
    • Customer Name
    • Withheld Claim Amount
    • ARCHService.Api.DTOs.ProductResponse
    • adminapi_HoldReason
    • Lienholder
    • refundquotes_BadRequest
    • ARCHService.Api.DTOs.ProgramResponse
    • adminapi_HoldCreateData
    • Dealer
    • refundquotes_NotFound
    • ARCHService.Api.DTOs.RateDisbursementResponse
    • adminapi_CancelPaymentDetails
    • Document
    • Cancel Reason Code
    • ARCHService.Api.DTOs.RateField
    • adminapi_PPMServiceData
    • Contract Number
    • Description
    • ARCHService.Api.DTOs.RateResponse
    • adminapi_RelatedDealer
    • Admin Company
    • Code
    • ARCHService.Api.DTOs.RelatedRate
    • adminapi_ClaimSearchResult
    • Name
    • Description
    • ARCHService.Api.DTOs.Surcharge
    • adminapi_PagedClaimSearchResult
    • Code
    • Cancel Method Type
    • ARCHService.Api.DTOs.Term
    • adminapi_ClaimContract
    • contracts_BadRequest
    • Contract Number
    • ARCHService.Api.DTOs.TermPlan
    • adminapi_ClaimAsset
    • contracts_NotFound
    • Name
    • ARCHService.Api.DTOs.TermPlanResponse
    • adminapi_ClaimDocument
    • Product Type
    • ARCHService.Api.DTOs.ToAccount
    • adminapi_ClaimBenefit
    • Make
    • ARCHService.Api.DTOs.User
    • adminapi_Claim
    • Model
    • ARCHService.Api.DTOs.Vehicle
    • adminapi_ClaimHoldReason
    • Year
    • ARCHService.Api.DTOs.WarrantyInfo
    • adminapi_PPMContractResult
    • First Name
    • ARCHSite.WebApi.Models.Account.AccountingLedger
    • adminapi_PPMContractEventResult
    • Lienholder Code
    • ARCHSite.WebApi.Models.Account.Address
    • adminapi_CashTransactionCreateData
    • Lienholder Name
    • ARCHSite.WebApi.Models.Account.AutoPayReceiveRequest
    • adminapi_ClaimPaymentRequest
    • Phone Number
    • ARCHSite.WebApi.Models.Account.CashTransaction
    • adminapi_CCCType
    • Address
    • ARCHSite.WebApi.Models.Account.CashTransactionCreateData
    • adminapi_CCCTypeCategoryValue
    • Number
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomField
    • Name
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomFieldCreateData
    • Dealer Address
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomFieldEditData
    • Document Name
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomFieldSearchData
    • Form Code
    • ARCHSite.WebApi.Models.Account.CashTransactionCustomFieldSearchResult
    • Description
    • ARCHSite.WebApi.Models.Account.CashTransactionSearchData
    • Name
    • ARCHSite.WebApi.Models.Account.CashTransactionSearchDataV1
    • Code
    • ARCHSite.WebApi.Models.Account.InProcessCashTransaction
    • Line 1
    • ARCHSite.WebApi.Models.Account.InProcessCashTransactionRequest
    • Line 2
    • ARCHSite.WebApi.Models.Account.InProcessCashTransactionSearchData
    • City
    • ARCHSite.WebApi.Models.Account.Ledger
    • State/Province
    • ARCHSite.WebApi.Models.Account.LedgerDetail
    • Postal Code (US, CA)
    • ARCHSite.WebApi.Models.Account.LedgerSearchData
    • ARCHSite.WebApi.Models.Account.LedgerSummary
    • ARCHSite.WebApi.Models.Account.LedgerSummaryRequest
    • ARCHSite.WebApi.Models.Account.Payment
    • ARCHSite.WebApi.Models.Account.PaymentRequest
    • ARCHSite.WebApi.Models.Account.Person
    • ARCHSite.WebApi.Models.Account.ProcessInProcessCashTransactionRequest
    • ARCHSite.WebApi.Models.Account.UnpaidLedgerFilter
    • ARCHSite.WebApi.Models.Account.UnpaidLedgerProduct
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolder
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderAutoExpireFailureResponse
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderAutoExpireResponse
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomField
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomFieldCreateData
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomFieldEditData
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomFieldSearchData
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderCustomFieldSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.AccountHolderStatementRequest
    • ARCHSite.WebApi.Models.AccountHolder.Agent
    • ARCHSite.WebApi.Models.AccountHolder.AgentCreateData
    • ARCHSite.WebApi.Models.AccountHolder.AgentSearchData
    • ARCHSite.WebApi.Models.AccountHolder.AgentSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.ClaimPayee
    • ARCHSite.WebApi.Models.AccountHolder.ClaimPayeeCreateData
    • ARCHSite.WebApi.Models.AccountHolder.ClaimPayeeSearchData
    • ARCHSite.WebApi.Models.AccountHolder.ClaimPayeeSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.Customer
    • ARCHSite.WebApi.Models.AccountHolder.CustomerSearchData
    • ARCHSite.WebApi.Models.AccountHolder.CustomerSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.Dealer
    • ARCHSite.WebApi.Models.AccountHolder.DealerCreateData
    • ARCHSite.WebApi.Models.AccountHolder.DealerGroup
    • ARCHSite.WebApi.Models.AccountHolder.DealerGroupCreateData
    • ARCHSite.WebApi.Models.AccountHolder.DealerGroupSearchData
    • ARCHSite.WebApi.Models.AccountHolder.DealerGroupSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.DealerInPortalVisibilityGroupSearchData
    • ARCHSite.WebApi.Models.AccountHolder.DealerRateVisibility
    • ARCHSite.WebApi.Models.AccountHolder.DealerRateVisibilityResult
    • ARCHSite.WebApi.Models.AccountHolder.DealerSearchData
    • ARCHSite.WebApi.Models.AccountHolder.DealerSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.DisbursementAccount
    • ARCHSite.WebApi.Models.AccountHolder.DisbursementAccountCreateData
    • ARCHSite.WebApi.Models.AccountHolder.DisbursementAccountSearchData
    • ARCHSite.WebApi.Models.AccountHolder.DisbursementAccountSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.GenericAccountHolderSearchData
    • ARCHSite.WebApi.Models.AccountHolder.GetDealerRateVisibilityResult
    • ARCHSite.WebApi.Models.AccountHolder.InspectionCompany
    • ARCHSite.WebApi.Models.AccountHolder.InspectionCompanyCreateData
    • ARCHSite.WebApi.Models.AccountHolder.InspectionCompanySearchData
    • ARCHSite.WebApi.Models.AccountHolder.InspectionCompanySearchResult
    • ARCHSite.WebApi.Models.AccountHolder.Insurer
    • ARCHSite.WebApi.Models.AccountHolder.InsurerCreateData
    • ARCHSite.WebApi.Models.AccountHolder.InsurerSearchData
    • ARCHSite.WebApi.Models.AccountHolder.InsurerSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.LienHolder
    • ARCHSite.WebApi.Models.AccountHolder.LienHolder2
    • ARCHSite.WebApi.Models.AccountHolder.LienHolder2SearchData
    • ARCHSite.WebApi.Models.AccountHolder.LienHolderCreateData
    • ARCHSite.WebApi.Models.AccountHolder.LienHolderList
    • ARCHSite.WebApi.Models.AccountHolder.LienHolderSearchData
    • ARCHSite.WebApi.Models.AccountHolder.LienHolderSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.PortalVisibilityGroup
    • ARCHSite.WebApi.Models.AccountHolder.PortalVisibilityGroupAddEditRequest
    • ARCHSite.WebApi.Models.AccountHolder.PortalVisibilityGroupDealerSearchResult
    • ARCHSite.WebApi.Models.AccountHolder.PortalVisibilityGroupSearchData
    • ARCHSite.WebApi.Models.AccountHolder.RepairFacility
    • ARCHSite.WebApi.Models.AccountHolder.RepairFacilityCreateData
    • ARCHSite.WebApi.Models.AccountHolder.RepairFacilitySearchData
    • ARCHSite.WebApi.Models.AccountHolder.RepairFacilitySearchResult
    • ARCHSite.WebApi.Models.AccountHolder.UserSearchData
    • ARCHSite.WebApi.Models.ACHTransactionRequest
    • ARCHSite.WebApi.Models.AutomaticProcessRun.AddRequest
    • ARCHSite.WebApi.Models.AutomaticProcessRun.AutomaticProcessRun
    • ARCHSite.WebApi.Models.AutomaticProcessRun.SearchRequest
    • ARCHSite.WebApi.Models.Claim.Adjustment
    • ARCHSite.WebApi.Models.Claim.CCCType
    • ARCHSite.WebApi.Models.Claim.CCCTypeCategoryValue
    • ARCHSite.WebApi.Models.Claim.CCCTypeCategoryValueSearchData
    • ARCHSite.WebApi.Models.Claim.CCCTypeSearchData
    • ARCHSite.WebApi.Models.Claim.Claim
    • ARCHSite.WebApi.Models.Claim.ClaimBenefit
    • ARCHSite.WebApi.Models.Claim.ClaimContract
    • ARCHSite.WebApi.Models.Claim.ClaimDetailComponent
    • ARCHSite.WebApi.Models.Claim.ClaimDocument
    • ARCHSite.WebApi.Models.Claim.ClaimIndexResult
    • ARCHSite.WebApi.Models.Claim.ClaimInspectionPatchRequest
    • ARCHSite.WebApi.Models.Claim.ClaimInspectionUpdate
    • ARCHSite.WebApi.Models.Claim.ClaimMiscPayment
    • ARCHSite.WebApi.Models.Claim.ClaimPaymentRequest
    • ARCHSite.WebApi.Models.Claim.ClaimSearchData
    • ARCHSite.WebApi.Models.Claim.CostData
    • ARCHSite.WebApi.Models.Claim.Deductible
    • ARCHSite.WebApi.Models.Claim.FileResultData
    • ARCHSite.WebApi.Models.Claim.GapData
    • ARCHSite.WebApi.Models.Claim.GapSettlement
    • ARCHSite.WebApi.Models.Claim.Inspection
    • ARCHSite.WebApi.Models.Claim.InspectionField
    • ARCHSite.WebApi.Models.Claim.InspectionFile
    • ARCHSite.WebApi.Models.Claim.InspectionFileData
    • ARCHSite.WebApi.Models.Claim.InspectionFileResult
    • ARCHSite.WebApi.Models.Claim.InspectionHoldReason
    • ARCHSite.WebApi.Models.Claim.InspectionNote
    • ARCHSite.WebApi.Models.Claim.InspectionReason
    • ARCHSite.WebApi.Models.Claim.Issue
    • ARCHSite.WebApi.Models.Claim.Labor
    • ARCHSite.WebApi.Models.Claim.MiscellaneousItem
    • ARCHSite.WebApi.Models.Claim.Ngine.ClaimInspection
    • ARCHSite.WebApi.Models.Claim.Ngine.ClaimInspectionField
    • ARCHSite.WebApi.Models.Claim.Ngine.ClaimInspectionNote
    • ARCHSite.WebApi.Models.Claim.Ngine.InspectionNotification
    • ARCHSite.WebApi.Models.Claim.Ngine.RepairFacility
    • ARCHSite.WebApi.Models.Claim.Ngine.Vehicle
    • ARCHSite.WebApi.Models.Claim.Note
    • ARCHSite.WebApi.Models.Claim.Part
    • ARCHSite.WebApi.Models.Claim.PPMClaimEvent
    • ARCHSite.WebApi.Models.Claim.RelatedDealer
    • ARCHSite.WebApi.Models.Claim.TakeRejectInspection
    • ARCHSite.WebApi.Models.Class.Asset
    • ARCHSite.WebApi.Models.Classing.Vehicle
    • ARCHSite.WebApi.Models.Contract.Cancel
    • ARCHSite.WebApi.Models.Contract.CancelMethod
    • ARCHSite.WebApi.Models.Contract.CancelMethodSearchData
    • ARCHSite.WebApi.Models.Contract.CancelPayment
    • ARCHSite.WebApi.Models.Contract.CancelPaymentDetails
    • ARCHSite.WebApi.Models.Contract.CancelReason
    • ARCHSite.WebApi.Models.Contract.CancelRequest
    • ARCHSite.WebApi.Models.Contract.CanceRequestExecutionData
    • ARCHSite.WebApi.Models.Contract.Contract
    • ARCHSite.WebApi.Models.Contract.ContractCancelData
    • ARCHSite.WebApi.Models.Contract.ContractDocument
    • ARCHSite.WebApi.Models.Contract.ContractSearchRequest
    • ARCHSite.WebApi.Models.Contract.ContractSearchResult
    • ARCHSite.WebApi.Models.Contract.ContractTransferRequest
    • ARCHSite.WebApi.Models.Contract.ExistingItemLockResult
    • ARCHSite.WebApi.Models.Contract.GeneratedContractDocument
    • ARCHSite.WebApi.Models.Contract.Hold
    • ARCHSite.WebApi.Models.Contract.HoldCreateData
    • ARCHSite.WebApi.Models.Contract.NewCancelRequestData
    • ARCHSite.WebApi.Models.Contract.NewCancelRequestOverrideData
    • ARCHSite.WebApi.Models.Contract.PDF
    • ARCHSite.WebApi.Models.Contract.RerateRequest
    • ARCHSite.WebApi.Models.Contract.Resolve
    • ARCHSite.WebApi.Models.Contract.SyncEarnings
    • ARCHSite.WebApi.Models.Contract.SyncEarnings.ContractEarningData
    • ARCHSite.WebApi.Models.Contract.SyncEarnings.ContractEarningData.EarningResult
    • ARCHSite.WebApi.Models.Control.ClaimHoldReason
    • ARCHSite.WebApi.Models.Control.ContractComponent
    • ARCHSite.WebApi.Models.Control.ContractCoverageGroup
    • ARCHSite.WebApi.Models.Control.CustomField
    • ARCHSite.WebApi.Models.Control.GeneralSetting
    • ARCHSite.WebApi.Models.Control.GeneralSettingGroup
    • ARCHSite.WebApi.Models.Control.GeneralSettingSearchData
    • ARCHSite.WebApi.Models.Control.GeneralSettingSearchResult
    • ARCHSite.WebApi.Models.Control.HoldReason
    • ARCHSite.WebApi.Models.Control.LimitOfLiability
    • ARCHSite.WebApi.Models.Control.LimitOfLiabilityResult
    • ARCHSite.WebApi.Models.Control.LimitOfLiabilityRule
    • ARCHSite.WebApi.Models.Document
    • ARCHSite.WebApi.Models.DocumentPostResponse
    • ARCHSite.WebApi.Models.DocumentService.DocumentCreateData
    • ARCHSite.WebApi.Models.ExternalReference
    • ARCHSite.WebApi.Models.FinancingData
    • ARCHSite.WebApi.Models.IdNameDescription
    • ARCHSite.WebApi.Models.InsurancePolicy
    • ARCHSite.WebApi.Models.InsuranceSettlement
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.Account.CashTransaction]
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.Account.UnpaidLedgerProduct]
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.AccountHolder.LienHolder2]
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.Claim.ClaimIndexResult]
    • ARCHSite.WebApi.Models.PagedResult[ARCHSite.WebApi.Models.Contract.ContractSearchResult]
    • ARCHSite.WebApi.Models.PagedResult[System.String]
    • ARCHSite.WebApi.Models.PaymentMethod
    • ARCHSite.WebApi.Models.Rate.AdminCompany
    • ARCHSite.WebApi.Models.Rate.AssetTypeRequestData
    • ARCHSite.WebApi.Models.Rate.CCCType
    • ARCHSite.WebApi.Models.Rate.ClaimSetting
    • ARCHSite.WebApi.Models.Rate.DisbursementRequestData
    • ARCHSite.WebApi.Models.Rate.Plan
    • ARCHSite.WebApi.Models.Rate.Product
    • ARCHSite.WebApi.Models.Rate.Program
    • ARCHSite.WebApi.Models.Rate.RateQuoteRequest
    • ARCHSite.WebApi.Models.Rate.VehicleBodyStyleRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleMakeRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleModelRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleSegmentationRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleSeriesRequestData
    • ARCHSite.WebApi.Models.Rate.VehicleTrimRequestData
    • ARCHSite.WebApi.Models.Reference
    • ARCHSite.WebApi.Models.SalesTax.SalesTaxCalculationRequest
    • ARCHSite.WebApi.Models.Warranty
    • Sefi.Admin.Accounting.SalesTax.CalculatedLineItemDetail
    • Sefi.Admin.Accounting.SalesTax.ContractSalesTaxDetail
    • Sefi.Admin.Accounting.SalesTax.SalesTaxLineItem
    • Sefi.Admin.Accounting.SalesTax.SalesTaxRule
    • Sefi.Admin.Accounting.SalesTax.SalesTaxType
    • SeFi.Documents.Model.Document
    • SeFi.Documents.Model.DocumentVersion
    • SeFi.Documents.Model.PresignedLink
    • SEServices.Warranty.ARCH.Environment.AccountHolderACH
    • SEServices.Warranty.ARCH.Environment.AvailablePaymentMethod
    • SEServices.Warranty.ARCH.Environment.ClaimInspectionReason
    • SEServices.Warranty.ARCH.Environment.Criterion
    • SEServices.Warranty.ARCH.Environment.CriterionGroup
    • SEServices.Warranty.ARCH.Environment.DuplicateGAPContracts_Result
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.Cancel
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.CancelDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.Contract
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ContractDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ContractEarningDetails
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ContractHold
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ContractHoldDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.LedgerDelete
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.LedgerEdit
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.Reinstatement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ReinstatementDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ReinstatementHold
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ReinstatementHoldDisbursement
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.Resolve
    • SEServices.Warranty.ARCH.Environment.EarningCalculationDetails.ResolveDisbursement
    • SEServices.Warranty.ARCH.Environment.FactorTable
    • SEServices.Warranty.ARCH.Environment.FactorTableEntry
    • SEServices.Warranty.ARCH.Environment.PaymentMethodACH
    • System.Net.Http.HttpMethod
  1. SEAdmin Swagger

Agents_GetAgents

GET
/agents

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
or
Query Params

Header Params

Responses

🟢200OK
application/json
OK
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/agents?searchData.billToAccountHolderId=undefined&searchData.number=undefined&searchData.parentAgentId=undefined&searchData.accountHolderId=undefined&searchData.businessAddressPhoneNumber=undefined&searchData.businessKey=undefined&searchData.extraPhoneNumber=undefined&searchData.name=undefined&searchData.physicalAddressPhoneNumber=undefined&searchData.region=undefined&searchData.systemCode=undefined&searchData.zipCode=undefined&searchData.ignoreCount=undefined&searchData.pageSize=undefined&searchData.page=undefined&searchData.maxPageSize=undefined' \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>'
Response Response Example
[
    {
        "accountCode": "string",
        "accountHolderId": 0,
        "accountHolderTypeId": 0,
        "billToAccountHolderId": 0,
        "businessKey": "string",
        "emailAddress": "string",
        "emailOptIn": true,
        "holdPayables": true,
        "isActive": true,
        "name": "string",
        "number": "string",
        "parentAgentId": 0,
        "preferredTransactionTypeId": 0,
        "preferredVirtualPaymentDeliveryMethodId": 0,
        "systemCode": "string"
    }
]
Modified at 2026-07-23 15:06:18
Previous
AdminCompanies_GetGeneralSettingById
Next
Agents_AddAgent
Built with