How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Socotra Policy API

The Policy API from Socotra — 180 operation(s) for policy.

Socotra Policy API is one of 18 APIs that Socotra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Policy. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 222 operations across 180 paths, and defines 130 schemas. It is described by OpenAPI 3.2.0, at version v0.

Requests are made against a single base URL, /.

222 operations 180 paths 130 schemas 22 DELETE69 GET73 PATCH46 POST12 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0
Base URL
https://api.sandbox.socotra.com
Terms of Service
Resource Areas
1

Paths & Operations 222

Across 180 paths, the API surfaces 222 operations — 22 DELETE, 69 GET, 73 PATCH, 46 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.

Policy 222
GET
/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}
getTransactionSchedule 4 params → 200
POST
/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}
uploadTransactionSchedule 3 params body → 200
PUT
/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}
addTransactionSchedule 3 params body → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}
updateTransactionSchedule 3 params body → 200
DELETE
/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}
deleteTransactionSchedule 3 params body → 200
PUT
/policy/{tenantLocator}/transactions/{locator}/elements
addElementsToPolicyWithTransaction 2 params body → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/elements
updateElementsInPolicyWithTransaction 2 params body → 200
DELETE
/policy/{tenantLocator}/transactions/{locator}/elements
removeElementsFromPolicyWithTransaction 2 params body → 200
PUT
/policy/{tenantLocator}/transactions/{locator}/changeInstructions
createPolicyChangeInstruction 2 params body → 200
GET
/policy/{tenantLocator}/quotes/{locator}/static
Gets static data for a quote
fetchStaticDataForQuote 2 params → 200
POST
/policy/{tenantLocator}/quotes/{locator}/static
Set the static extension data on a quote
addStaticDataForQuote 2 params body → 200
PUT
/policy/{tenantLocator}/quotes/{locator}/static
Replaces all of the static data on a quote
replaceAllStaticDataForQuote 2 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/static
Updates some of the static data on a quote
updateStaticDataForQuote 2 params body → 200
GET
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}
fetchScheduleItems 4 params → 200
POST
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}
uploadScheduleItems 3 params body → 200
PUT
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}
addScheduleItems 3 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}
updateScheduleItems 3 params body → 200
DELETE
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}
deleteScheduleItems 3 params body → 200
PUT
/policy/{tenantLocator}/quotes/{locator}/elements
addElementsToQuote 2 params body → 200
DELETE
/policy/{tenantLocator}/quotes/{locator}/elements
removeElementsFromQuote 2 params body → 200
PUT
/policy/{tenantLocator}/quickquotes/{locator}/elements
addElementsToQuickQuote 2 params body → 200
DELETE
/policy/{tenantLocator}/quickquotes/{locator}/elements
deleteElementsFromQuickQuote 2 params body → 200
GET
/policy/{tenantLocator}/policies/{locator}/static
Gets the static data on a policy
fetchStaticDataForPolicy 2 params → 200
POST
/policy/{tenantLocator}/policies/{locator}/static
Set the static extension data on a policy
addStaticDataForPolicy 2 params body → 200
PUT
/policy/{tenantLocator}/policies/{locator}/static
Replaces all of the static data on a policy
replaceAllStaticDataForPolicy 2 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/static
Updates some of the static data on a policy
updateStaticDataForPolicy 2 params body → 200
PUT
/policy/{tenantLocator}/policies/{locator}/moratoriums/elections
addPolicyMoratoriumElections 2 params body → 200
DELETE
/policy/{tenantLocator}/policies/{locator}/moratoriums/elections
deletePolicyMoratoriumElections 2 params body → 200
PUT
/policy/{tenantLocator}/holds
Fetches all entity holds for the current user
createEntityHold 1 param body → 200
GET
/policy/{tenantLocator}/autoRenewals/{locator}
fetchAutoRenewal 2 params → 200
PUT
/policy/{tenantLocator}/autoRenewals/{locator}
Creates or replaces all the specified data on the auto renewal, including null values.
putAutoRenewal 2 params body → 200
PATCH
/policy/{tenantLocator}/autoRenewals/{locator}
updateAutoRenewal 2 params body → 200
GET
/policy/{tenantLocator}/accounts/{locator}
fetchAccount 2 params → 200
PUT
/policy/{tenantLocator}/accounts/{locator}
Updates the account and replaces all existing data extensions with the new data.
updateAccountReplaceData 2 params body → 200
PATCH
/policy/{tenantLocator}/accounts/{locator}
Updates the account and individual data extensions.
updateAccount 2 params body → 200
POST
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/reject
addRejectUnderwritingFlagsForTransaction 2 params body → 200
POST
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/info
addInfoUnderwritingFlagsForTransaction 2 params body → 200
POST
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/decline
addDeclineUnderwritingFlagsForTransaction 2 params body → 200
POST
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/block
addBlockUnderwritingFlagsForTransaction 2 params body → 200
POST
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/approve
addApproveUnderwritingFlagsForTransaction 2 params body → 200
POST
/policy/{tenantLocator}/transactions/{locator}/schedules/{staticElementLocator}/deserialize
uploadDeserializedTransactionSchedule 4 params body → 200
POST
/policy/{tenantLocator}/transactions/{locator}/elements/constraints/evaluate
evaluateConstraintsForPolicyTransaction 2 params body → 200
POST
/policy/{tenantLocator}/terms/{locator}/number/set
setTermNumber 3 params → 200
POST
/policy/{tenantLocator}/terms/{locator}/number/generate
generateTermNumber 2 params → 200
POST
/policy/{tenantLocator}/quotes
createQuote 1 param body → 200
GET
/policy/{tenantLocator}/quotes/{quoteLocator}/contacts
fetchQuoteContacts 2 params → 200
POST
/policy/{tenantLocator}/quotes/{quoteLocator}/contacts
addQuoteContact 2 params body → 200
POST
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/reject
addUnderwritingRejectFlagForQuote 2 params body → 200
POST
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/info
addUnderwritingInfoFlagForQuote 2 params body → 200
POST
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/decline
addUnderwritingDeclineFlagForQuote 2 params body → 200
POST
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/block
addUnderwritingBlockFlagForQuote 2 params body → 200
POST
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/approve
addUnderwritingApproveFlagForQuote 2 params body → 200
POST
/policy/{tenantLocator}/quotes/{locator}/schedules/{staticElementLocator}/deserialize
uploadDeserializedScheduleItems 4 params body → 200
POST
/policy/{tenantLocator}/quotes/{locator}/reservedPolicyNumber/set
setReservedPolicyNumber 3 params → 200
POST
/policy/{tenantLocator}/quotes/{locator}/number/set
setQuoteNumber 3 params → 200
POST
/policy/{tenantLocator}/quotes/{locator}/number/generate
generateQuoteNumber 2 params → 200
POST
/policy/{tenantLocator}/quotes/{locator}/copy
copyQuote 2 params body → 200
POST
/policy/{tenantLocator}/quotes/{locator}/constraints/evaluate
evaluateConstraintsForQuote 2 params body → 200
POST
/policy/{tenantLocator}/quotes/validatePreview
quoteValidatePreview 1 param body → 200
POST
/policy/{tenantLocator}/quotes/pricePreview
quotePricePreview 1 param body → 200
POST
/policy/{tenantLocator}/quotes/groups
createQuoteGroup 1 param body → 200
POST
/policy/{tenantLocator}/quickquotes
createQuickQuote 1 param body → 200
GET
/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts
fetchQuickQuoteContacts 2 params → 200
POST
/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts
addQuickQuoteContact 2 params body → 200
POST
/policy/{tenantLocator}/quickquotes/{locator}/quote/{accountLocator}
createQuoteFromQuickQuote 4 params → 200
POST
/policy/{tenantLocator}/quickquotes/{locator}/copy
copyQuickQuote 2 params body → 200
POST
/policy/{tenantLocator}/quickquotes/{locator}/constraints/evaluate
evaluateConstraintsForQuickQuote 2 params body → 200
POST
/policy/{tenantLocator}/quickquotes/validatePreview
quickQuoteValidatePreview 1 param body → 200
POST
/policy/{tenantLocator}/quickquotes/pricePreview
quickQuotePricePreview 1 param body → 200
GET
/policy/{tenantLocator}/policies/{policyLocator}/contacts
fetchPolicyContacts 2 params → 200
POST
/policy/{tenantLocator}/policies/{policyLocator}/contacts
addPolicyContact 2 params body → 200
POST
/policy/{tenantLocator}/policies/{locator}/quote
createQuoteFromPolicy 5 params → 200
POST
/policy/{tenantLocator}/policies/{locator}/number/set
setPolicyNumber 3 params → 200
POST
/policy/{tenantLocator}/policies/{locator}/number/generate
generatePolicyNumber 2 params → 200
POST
/policy/{tenantLocator}/autoRenewals
createAutoRenewal 1 param body → 200
POST
/policy/{tenantLocator}/accounts
createAccount 1 param body → 200
POST
/policy/{tenantLocator}/accounts/{locator}/number/set
setAccountNumber 3 params → 200
POST
/policy/{tenantLocator}/accounts/{locator}/number/generate
generateAccountNumber 2 params → 200
POST
/policy/{tenantLocator}/accounts/{locator}/constraints/evaluate
evaluateConstraintsForAccount 2 params body → 200
GET
/policy/{tenantLocator}/accounts/{accountLocator}/contacts
fetchAccountContacts 2 params → 200
POST
/policy/{tenantLocator}/accounts/{accountLocator}/contacts
addAccountContact 2 params body → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/validate
validateTransaction 3 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags
fetchUnderwritingFlagsForTransaction 2 params → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags
updateUnderwritingFlagsForPolicyTransaction 2 params body → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/underwrite
underwriteTransaction 3 params → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/transactionData
patchTransactionData 2 params body → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/reset
resetTransaction 3 params body → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/refuse
refuseTransaction 2 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/price
fetchTransactionPricing 2 params → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/price
priceTransaction 3 params → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/precommit
precommitTransaction 2 params → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/issue
issueTransaction 3 params → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/initialize
initializeTransaction 2 params → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/discard
discardTransaction 2 params → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/changeInstructions/{instructionLocator}
updateChangeInstruction 3 params body → 200
DELETE
/policy/{tenantLocator}/transactions/{locator}/changeInstructions/{instructionLocator}
deleteChangeInstructionFromTransaction 3 params → 200
PATCH
/policy/{tenantLocator}/transactions/{locator}/accept
acceptTransaction 2 params → 200
PATCH
/policy/{tenantLocator}/quotes/{quoteLocator}/contacts/{contactLocator}
updateQuoteContact 3 params body → 200
DELETE
/policy/{tenantLocator}/quotes/{quoteLocator}/contacts/{contactLocator}
deleteQuoteContact 3 params → 200
GET
/policy/{tenantLocator}/quotes/{locator}
fetchQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}
updateQuote 2 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/validate
validateQuote 3 params → 200
GET
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags
fetchUnderwritingFlagsForQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags
updateUnderwritingFlagsForQuote 2 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/underwrite
underwriteQuote 3 params → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/reset
resetQuote 2 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/refuse
refuseQuote 2 params → 200
GET
/policy/{tenantLocator}/quotes/{locator}/price
fetchPricedQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/price
priceQuote 3 params → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/precommit
precommitQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/issue
issueQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/invoiceFeeAmount
updateQuoteInvoiceFeeAmount 2 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/discard
discardQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/delinquencyPlan
updateQuoteDelinquencyPlan 2 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/billingLevel
updateBillingLevelForAQuote 2 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/autoRenewalPlan
updateQuoteAutoRenewalPlan 2 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/assignToGroup
assignQuoteGroup 2 params body → 200
PATCH
/policy/{tenantLocator}/quotes/{locator}/accept
acceptQuote 2 params → 200
GET
/policy/{tenantLocator}/quotes/groups/{locator}
fetchQuoteGroup 2 params → 200
PATCH
/policy/{tenantLocator}/quotes/groups/{locator}
updateQuoteGroup 2 params body → 200
DELETE
/policy/{tenantLocator}/quotes/groups/{locator}
deleteQuoteGroup 2 params → 200
PATCH
/policy/{tenantLocator}/quotes/groups/{locator}/validate
validateQuoteGroup 2 params → 200
PATCH
/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}
updateQuickQuoteContact 3 params body → 200
DELETE
/policy/{tenantLocator}/quickquotes/{quoteLocator}/contacts/{contactLocator}
deleteQuickQuoteContact 3 params → 200
GET
/policy/{tenantLocator}/quickquotes/{locator}
fetchQuickQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quickquotes/{locator}
updateQuickQuote 2 params body → 200
PATCH
/policy/{tenantLocator}/quickquotes/{locator}/validate
validateQuickQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quickquotes/{locator}/reset
resetQuickQuote 2 params → 200
GET
/policy/{tenantLocator}/quickquotes/{locator}/price
fetchPricingForQuickQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quickquotes/{locator}/price
priceAQuickQuote 2 params → 200
PATCH
/policy/{tenantLocator}/quickquotes/{locator}/discard
discardQuickQuote 2 params → 200
PATCH
/policy/{tenantLocator}/policies/{policyLocator}/contacts/{contactLocator}
updatePolicyContact 3 params body → 200
DELETE
/policy/{tenantLocator}/policies/{policyLocator}/contacts/{contactLocator}
deletePolicyContact 3 params → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/{transactionType}
createPolicyTransaction 4 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/{transactionType}/validatePreview
transactionValidatePreview 4 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/{transactionType}/underwritePreview
underwritePreview 4 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/{transactionType}/pricePreview
transactionPricePreview 4 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/reversal
reversePolicyChange 2 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/renew
renewPolicy 3 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/reinstate
reinstatePolicy 3 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/jurisdiction
updatePolicyJurisdiction 2 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/invoiceFeeAmount
updatePolicyInvoiceFeeAmount 2 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/delinquencyPlan
updatePolicyDelinquencyPlan 2 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/change
changePolicy 3 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/cancel
cancelPolicy 3 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/billingLevel
updateBillingLevelForAPolicy 2 params body → 200
PATCH
/policy/{tenantLocator}/policies/{locator}/autoRenewalPlan
updatePolicyAutoRenewalPlan 2 params body → 200
GET
/policy/{tenantLocator}/holds/{locator}
Fetches an entity hold by its locator
fetchEntityHold 2 params → 200
PATCH
/policy/{tenantLocator}/holds/{locator}
Updates an entity hold by its locator
updateEntityHold 2 params body → 200
PATCH
/policy/{tenantLocator}/holds/{locator}/validate
Validates an entity hold by its locator
validateEntityHold 2 params → 200
PATCH
/policy/{tenantLocator}/holds/{locator}/release
Releases an entity hold by its locator
releaseEntityHold 2 params → 200
PATCH
/policy/{tenantLocator}/holds/{locator}/discard
Discards an entity hold by its locator
discardEntityHold 2 params → 200
PATCH
/policy/{tenantLocator}/holds/{locator}/activate
Activates an entity hold by its locator
activateEntityHold 2 params → 200
PATCH
/policy/{tenantLocator}/deserializeJobs/{locator}/terminate
terminateDeserializationJob 2 params → 200
PATCH
/policy/{tenantLocator}/deserializeJobs/{locator}/restart
restartDeserializationJob 2 params → 200
PATCH
/policy/{tenantLocator}/autoRenewals/{locator}/doNotRenew
Prevents renewal of the policy, either with auto-renew or manually.
markPolicyForDoNotRenew 2 params → 200
PATCH
/policy/{tenantLocator}/autoRenewals/{locator}/discard
Discards and prevents auto renewal unless a new one is created.
discardAutoRenewal 2 params → 200
PATCH
/policy/{tenantLocator}/autoRenewals/{locator}/activate
Restarts autorenewal when it has been previously put into doNotRenew, error, or terminated state.
reactivateAutoRenewal 2 params → 200
PATCH
/policy/{tenantLocator}/accounts/{locator}/validate
validateAccount 2 params → 200
PATCH
/policy/{tenantLocator}/accounts/{locator}/billingLevel
updateBillingLevelForAnAccount 2 params body → 200
PATCH
/policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}
updateAccountContact 3 params body → 200
DELETE
/policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}
deleteAccountContact 3 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}
fetchTransaction 2 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/segments/{segmentLocator}deprecated
fetchPolicySegmentEx 3 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/segments/listdeprecated
fetchTransactionSegments 2 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/segment
fetchTransactionSegment 2 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/schedules
getTransactionSchedules 2 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/preferences
fetchPreferencesForATransaction 2 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/elements/constraints/dependency
fetchDependencyMapForPolicyTransaction 2 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/elements/changes
fetchPolicyTransactionWithUpdatedChanges 2 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/affectedTransactions
fetchAffectedTransactions 2 params → 200
GET
/policy/{tenantLocator}/transactions/{locator}/affectedTransactions/listdeprecated
fetchAffectedTransactionsForListEndpoint 2 params → 200
GET
/policy/{tenantLocator}/transactions/segments/{segmentLocator}
fetchPolicySegment 2 params → 200
GET
/policy/{tenantLocator}/terms/{locator}
fetchTerm 2 params → 200
GET
/policy/{tenantLocator}/terms/{locator}/summary
fetchTermSummaryByTermLocator 2 params → 200
GET
/policy/{tenantLocator}/terms/{locator}/payable
fetchTermPayableAmounts 2 params → 200
GET
/policy/{tenantLocator}/terms/{locator}/charges
fetchTermCharges 2 params → 200
GET
/policy/{tenantLocator}/terms/numbers/{termNumber}
fetchTermsWithNumber 2 params → 200
GET
/policy/{tenantLocator}/quotes/{locator}/static/history/list
listStaticDataForQuote 4 params → 200
GET
/policy/{tenantLocator}/quotes/{locator}/schedules
fetchSchedules 2 params → 200
GET
/policy/{tenantLocator}/quotes/{locator}/moratoriums
getQuoteMoratoriumsStatuses 2 params → 200
GET
/policy/{tenantLocator}/quotes/{locator}/holds
fetchQuoteHolds 2 params → 200
GET
/policy/{tenantLocator}/quotes/{locator}/constraints/dependency
fetchDependencyMapForQuote 2 params → 200
GET
/policy/{tenantLocator}/quotes/numbers/{quoteNumber}
fetchQuotesWithNumber 2 params → 200
GET
/policy/{tenantLocator}/quotes/list
fetchQuotesInATenant 4 params → 200
GET
/policy/{tenantLocator}/quotes/groups/{locator}/list
fetchAllQuotesInGroup 4 params → 200
GET
/policy/{tenantLocator}/quotes/groups/name/{name}
fetchQuoteGroupByName 2 params → 200
GET
/policy/{tenantLocator}/quotes/groups/list
fetchQuoteGroupsInATenant 3 params → 200
GET
/policy/{tenantLocator}/quotes/group/{locator}/list
fetchAllQuotesInGroup_1 5 params → 200
GET
/policy/{tenantLocator}/quickquotes/{locator}/constraints/dependency
fetchDependencyMapForQuickQuote 2 params → 200
GET
/policy/{tenantLocator}/quickquotes/list
fetchMultipleQuickQuotes 4 params → 200
GET
/policy/{tenantLocator}/policies/{locator}
fetchPolicy 2 params → 200
GET
/policy/{tenantLocator}/policies/{locator}/terms/list
fetchMultipleTerms 5 params → 200
GET
/policy/{tenantLocator}/policies/{locator}/summary
fetchTermSummaryByTermNumber 3 params → 200
GET
/policy/{tenantLocator}/policies/{locator}/static/history/list
listStaticDataForPolicy 4 params → 200
GET
/policy/{tenantLocator}/policies/{locator}/snapshot
fetchPolicySnapshot 4 params → 200
GET
/policy/{tenantLocator}/policies/{locator}/moratoriums
getPolicyMoratoriumsStatuses 2 params → 200
GET
/policy/{tenantLocator}/policies/{locator}/moratoriums/elections/history/list
getPolicyMoratoriumElectionsHistory 4 params → 200
GET
/policy/{tenantLocator}/policies/{locator}/issuedTransactions/list
Fetches the 'local stack' of issued transactions, excluding those that have been reversed or reapplied
fetchIssuedTransactions 5 params → 200
GET
/policy/{tenantLocator}/policies/{locator}/holds
fetchPolicyHolds 2 params → 200
GET
/policy/{tenantLocator}/policies/{locator}/branches
getTransactionsBranchesByPolicy 2 params → 200
GET
/policy/{tenantLocator}/policies/snapshot/listdeprecated
fetchMultipleSnapshots 3 params → 200
GET
/policy/{tenantLocator}/policies/numbers/{policyNumber}
fetchPoliciesWithNumber 2 params → 200
GET
/policy/events
fetchPolicyEventDefinitions → 200
GET
/policy/{tenantLocator}/deserializeJobs/{locator}
fetchDeserializeScheduleItemsJob 2 params → 200
GET
/policy/{tenantLocator}/deserializeJobs/{jobType}/list
listDeserializeScheduleItemsJobs 5 params → 200
GET
/policy/{tenantLocator}/accounts/{locator}/quotes/list
fetchQuotesForAccount 6 params → 200
GET
/policy/{tenantLocator}/accounts/{locator}/policies/snapshot/list
fetchPolicySnapshotsForAnAccount 5 params → 200
GET
/policy/{tenantLocator}/accounts/{locator}/policies/list
fetchPoliciesForAccount 6 params → 200
GET
/policy/{tenantLocator}/accounts/{locator}/constraints/dependency
fetchDependencyMapForAccount 2 params → 200
GET
/policy/{tenantLocator}/accounts/numbers/{accountNumber}
fetchAccountsWithNumber 2 params → 200
GET
/policy/{tenantLocator}/accounts/list
fetchMultipleAccounts 4 params → 200
DELETE
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/reject/{flagLocator}
clearRejectUnderwritingFlagsForTransaction 3 params → 200
DELETE
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/info/{flagLocator}
clearInfoUnderwritingFlagsForTransaction 3 params → 200
DELETE
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/decline/{flagLocator}
clearDeclineUnderwritingFlagsForTransaction 3 params → 200
DELETE
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/block/{flagLocator}
clearBlockUnderwritingFlagsForTransaction 3 params → 200
DELETE
/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/approve/{flagLocator}
clearApproveUnderwritingFlagsForTransaction 3 params → 200
DELETE
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/reject/{flagLocator}
clearUnderwritingRejectFlagForQuote 3 params → 200
DELETE
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/info/{flagLocator}
clearUnderwritingInfoFlagForQuote 3 params → 200
DELETE
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/decline/{flagLocator}
clearUnderwritingDeclineFlagForQuote 3 params → 200
DELETE
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/block/{flagLocator}
clearUnderwritingBlockFlagForQuote 3 params → 200
DELETE
/policy/{tenantLocator}/quotes/{locator}/underwritingFlags/approve/{flagLocator}
clearUnderwritingApproveFlagForQuote 3 params → 200

Schemas 130

The contract defines 130 schemas that model the data the API accepts and returns. The most detailed are TransactionEvents (54 properties), QuoteResponse (35 properties), QuickQuoteQuoteDetails (33 properties), PolicyResponse (30 properties). Each schema is shown below with its type and property counts.

TransactionPriceResponse
object
8 properties 6 required
TermSummary
object
9 properties 9 required
TransactionUnderwritingEventData
object
3 properties 3 required
SubsegmentSummary
object
9 properties 8 required
UnderwritingTaskCreateRequest
object
9 properties 3 required
ElementSummary
object
5 properties 5 required
TermListResponse
object
2 properties 2 required
PolicyTransactionResponse
object
24 properties 11 required
MoratoriumStatus
object
4 properties 4 required
PolicyListResponse
object
2 properties 2 required
AccountEventData
object
1 property 1 required
PolicyStatusEvents
object
1 property
QuoteGroupResponse
object
9 properties 7 required
AutoRenewalCreateRequest
object
9 properties 3 required
QuickQuoteCreateRequest
object
12 properties 4 required
QuoteEvents
object
16 properties
AccountCreateRequest
object
15 properties 1 required
QuoteUnderwrittenEventData
object
2 properties 2 required
QuoteHoldScope
object
1 property 1 required
StaticDataHistoryResponse
object
4 properties 4 required
QuoteUpdateRequest
object
21 properties 19 required
NumberingEvents
object
6 properties
ValidationResult
object
2 properties 1 required
ListPageResponseQuote
object
2 properties 2 required
PatchScheduleItemRequest
object
3 properties 3 required
UpdateInvoiceFeeAmountRequest
object
1 property 1 required
DeserializationRequestMetadata
object
6 properties 6 required
QuoteGroupAssignmentRequest
object
1 property 1 required
ScheduleItemsResponse
object
2 properties 2 required
TaskCreationResponse
object
2 properties 2 required
QuoteListResponse
object
2 properties 2 required
PolicyHoldScope
object
3 properties 3 required
ListPageResponseStaticDataHistoryResponse
object
2 properties 2 required
ProducerInfo
object
2 properties
AffectedTransaction
object
2 properties 2 required
PatchTransactionDataRequest
object
2 properties 2 required
QuoteGroupFieldEnforcementDeclaration
object
2 properties 2 required
TransactionUnderwritingFlagsResponse
object
3 properties 3 required
UnderwritingFlagResponse
object
12 properties 11 required
UpdateEntityHoldRequest
object
7 properties 7 required
ConfigMigrationEventPayload
object
2 properties 2 required
ResetOptions
object
6 properties 6 required
InstallmentPreferences
object
13 properties 1 required
AccountUpdateReplaceDataRequest
object
15 properties 1 required
PolicyConfigMigrationEventPayload
object
3 properties 3 required
PolicyStatusEventData
object
3 properties 3 required
ElementResponse
object
9 properties 5 required
TermPayableResponse
object
7 properties 7 required
QuoteResponse
object
35 properties 7 required
PolicyChargeResponse
object
13 properties 10 required
PolicyTransactionListResponse
object
2 properties 2 required
QuotePolicyNumberData
object
2 properties 2 required
AccountUpdateRequest
object
14 properties 14 required
UpdateJurisdictionRequest
object
1 property
QuickQuoteListResponse
object
2 properties 2 required
QuoteEventData
object
1 property 1 required
ListPageResponseDeserializationJob
object
2 properties 2 required
AutoRenewalPlanUpdateRequest
object
1 property 1 required
SegmentResponse
object
10 properties 7 required
TransactionSnapshotResponse
object
7 properties 7 required
ContactAssociationUpdateRequest
object
2 properties 2 required
TransactionManualUnderwritingEventData
object
2 properties 2 required
ConditionValue
object
3 properties 3 required
TermResponse
object
10 properties 6 required
ListPageResponseQuoteGroup
object
2 properties 2 required
DocumentSummary
object
6 properties 4 required
PolicyTransactionReversalRequest
object
3 properties 3 required
ListPageResponsePolicyStatus
object
2 properties 2 required
UnderwritingFlagsUpdateRequest
object
2 properties 2 required
ConstraintDependency
object
3 properties 3 required
QuoteCreateRequest
object
23 properties 6 required
DeserializationResponse
object
1 property 1 required
DeleteChangeInstructionCreateRequest
object
2 required
ElementCreateRequest
object
6 properties 1 required
MigrateChangeInstructionCreateRequest
object
1 required
QuoteGroupValidationResponse
object
2 properties 2 required
TaskReference
object
2 properties 2 required
NumberingData
object
1 property 1 required
QuickQuotePriceResponse
object
12 properties 10 required
QuickQuoteUpdateRequest
object
12 properties 11 required
TransactionUnderwritingResponse
object
9 properties 6 required
QuickQuoteResponse
object
19 properties 5 required
EntityHold
object
11 properties 10 required
TransactionEvents
object
54 properties
ParamsChangeInstructionCreateRequest
object
2 required
AddScheduleItemRequest
object
1 property 1 required
MoratoriumElectionRequest
object
2 properties 2 required
QuickQuoteQuoteResponse
object
11 properties 8 required
PolicyResponse
object
30 properties 18 required
ConfigMigrationEvents
object
3 properties
ModifyChangeInstructionCreateRequest
object
6 required
QuoteGroupUpdateRequest
object
6 properties 6 required
QuoteManuallyUnderwrittenEventData
object
1 property 1 required
AccountEvents
object
5 properties
ElementScheduleResponse
object
5 properties 5 required
StaticDataUpdateRequest
object
2 properties 2 required
ProducersChangeInstructionCreateRequest
object
1 required
UnderwritingFlagCreateRequest
object
5 properties 5 required
AddChangeInstructionCreateRequest
object
2 required
ValidationItemResponse
object
3 properties 3 required
DelinquencyPlanUpdateRequest
object
1 property 1 required
AutoRenewalPutRequest
object
6 properties 1 required
PolicySnapshotListResponse
object
2 properties 2 required
TransactionEventData
object
2 properties 2 required
PolicyEvents
object
3 properties
AccountResponse
object
22 properties 10 required
ScheduleItem
object
6 properties 6 required
QuotePriceResponse
object
12 properties 10 required
QuoteGroupSettings
object
3 properties 3 required
PolicyLocatorData
object
1 property 1 required
PolicyStaticDataEvents
object
4 properties
PolicyMoratoriumElectionHistoryResponse
object
4 properties 4 required
AccountListResponse
object
2 properties 2 required
PolicySnapshotResponse
object
9 properties 8 required
ElementUpdateRequest
object
5 properties 5 required
CreateEntityHoldRequest
object
6 properties 2 required
PreferencesResponse
object
1 property
ChangeInstructionCreateRequest
object
1 property 1 required
QuickQuoteQuoteDetails
object
33 properties 8 required
QuoteUnderwritingResponse
object
12 properties 11 required
DeserializationJob
object
9 properties 8 required
MoratoriumStatusesResponse
object
2 properties 2 required
QuoteGroupCreateRequest
object
5 properties 5 required
ContactRoles
object
2 properties 2 required
QuoteUnderwritingFlagsResponse
object
3 properties 2 required
AutoRenewalUpdateRequest
object
6 properties
UpdateBillingLevelRequest
object
1 property 1 required
PolicyServiceEventTypeDefinitions
object
8 properties 8 required
TransactionDataChangeInstructionCreateRequest
object
2 required
AutoRenewalResponse
object
14 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

socotra-policy-api-openapi.yml Raw ↑

Other APIs Socotra publishes across the network.

Socotra Auth API
Socotra Auxdata API
Socotra Billing API
Socotra Business Stats API
Socotra Claim API
Socotra Compliance API
Socotra Config API
Socotra Contact API
Socotra Document API
Socotra Event API
Socotra Migration API
Socotra Payment Execution API
Where this information came from

This is an independent, third-party profile of Socotra Policy API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.