Skip to main content

PoliciesResult

No description

union PoliciesResult = PoliciesConnection | UnauthorizedOperationError | InputValidationError | RateLimitedError | UnexpectedError

Possible types​

PoliciesResult.PoliciesConnection object​

One page of policies.

PoliciesResult.UnauthorizedOperationError object​

Error indicating the partner lacks required authorization for the requested operation.

Common causes:

  • Missing permissions to sell the specific product
  • Missing permission to read policies
  • Reading the policies of sub-brokers without entire-tree access

PoliciesResult.InputValidationError object​

Error indicating that the provided input data failed validation.

Resolution:

  • Check the invalidInput field for specific validation errors
  • Ensure all required fields are provided
  • Verify that field values meet the specified constraints

PoliciesResult.RateLimitedError object​

This broker has read more policy valuations than its budget allows in the current window, so no policies were returned.

Wait retryAfterSeconds and repeat the request unchanged. A retry inside the window consumes nothing and returns this same error, so a tight retry loop will still be running when the next window opens.

One request that selects Policy.fundValue costs one unit, whatever its page size. A request that omits the field never touches the budget. The budget is per broker, not per integration: each broker you may act for carries its own.

PoliciesResult.UnexpectedError object​

In case an unexpected error occurs during the update customer operation. Please contact customer support for assistance.

Returned By​

policies query