MarketConnect-OrderEntry

Market Connect Order Entry API

Updates signer email or phone for a case while e-signature is pending upstream.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • 401 Unauthorized

  • UNAUTHORIZED - Authentication failed or the access token is missing, expired, or invalid.

  • 403 Forbidden

  • FORBIDDEN - The authenticated user is not authorized to access this resource.

  • 404 Not Found

  • TRANSACTION_ID_NOT_FOUND - No transaction exists for the specified transaction ID.

  • 429 Too Many Requests

  • RATE_LIMIT_EXCEEDED - The client has exceeded the permitted request rate or quota.

  • 500 Internal Server Error

  • UNEXPECTED_ERROR - An unexpected internal system error occurred while processing the request.

  • 502 Bad Gateway

  • UPSTREAM_SERVICE_ERROR - An upstream dependency returned an invalid or unsuccessful response.

  • 503 Service Unavailable

  • SERVICE_UNAVAILABLE - The service or a required dependency is temporarily unavailable.

  • 504 Gateway Timeout

  • UPSTREAM_TIMEOUT - A required downstream service did not respond within the configured timeout.

Standard Error Response

All error responses conform to the standard ErrorResponse schema and include:

  • A stable error code from ErrorInfo.code.
  • A human-readable error message.
  • Optional diagnostic details, when applicable.
  • A timestamp indicating when the error occurred.
    This consistent format enables clients to implement standardized error processing, logging, and troubleshooting across all Order Entry API endpoints.
post

Body

application/json

Transaction ID and signer rows with corrected email and/or phone while e-signature is pending upstream.

* Additional properties are NOT allowed.
transactionIdinteger(int64)

Transaction (case) identifier whose signer contact details should be updated.

>= 1

signersarray[object]required

Signer rows with corrected email and/or phone while e-sign is pending.

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Returns the update result envelope

UpdateEsignSignerDetailsResponse

* Additional properties are NOT allowed.
successboolean

True when signer contact details were updated (e-sign must be pending upstream).

messagestring | null

User-safe message confirming the update or describing a failure.

post/market-connect/order-entry/v1/esignature/update-signer

Body

{ "transactionId": 1131068, "signers": [ { "recipientId": "11306862", "signerEmail": "corrected.email@everglades.com", "signerSequence": "1", "signerAuthMethod": "Phone", "signerCountryCode": "1", "signerPhoneNo": "8650827071" } ] }
 
application/json

Health

Health check operations

Returns a simple health status indicating the API process is running.

Returns a simple health status. No authentication required.

get

Response

200

API is healthy

get/market-connect/order-entry/v1/health
 
200

AdditionalDocumentType

object
* Additional properties are NOT allowed.
attachmentTypearray[string]

List of attachment type codes

documentTypearray[string]

List of document type codes

formTypearray[string]

List of form type codes

Example

AttachmentData

object
* Additional properties are NOT allowed.
additionalDocumentTypesarray[object]

Document types the user may optionally upload.

* Additional properties are NOT allowed.
Show Child Parameters
documentRulesarray[object]

Conditional rules for required or optional documents.

* Additional properties are NOT allowed.
Show Child Parameters
documentsarray[object]

Files already stored for the transaction, including EDS documentId and documentSize in bytes.

Example:{"documentType":"ESIGNATURE","fileName":"NAICBuyerGuideFixedDeferredAnnuitiesMTNM.pdf","uploadDate":"04/06/2026 11:22:05 PM","documentId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","documentSize":9000000,"attachmentType":null,"formType":null}

* Additional properties are NOT allowed.
Show Child Parameters
requiredDocumentsarray[object]

Documents still required before submission.

* Additional properties are NOT allowed.
Show Child Parameters
Example