Get Service Order Status

get

https://api.elliemae.com/services/v1/partners/{partnerId}/transactions/{transactionId}

Retrieves details on a service order transaction. Metadata for files/attachments returned by the service provider are encapsulated in the response body.

Note: The Transaction object will eventually be replaced by the Resource_Transaction object across all service categories and providers. This new response schema will allow API users to access and retrieve viewable eFolder documents/attachments as well as native file formats returned by the service provider.

Path Params

partnerId

string

required

Ellie Mae's unique identifier for the Partner service provider. Partner ID's can be located on the sample pages for each of the service categories.

transactionId

string

required

The unique identifier of the transaction provided in the response header when the order was submitted.

Query Params

generateFileUrls

string

This parameter only applies for transaction objects of type Resource_Transaction and is effective only for users with admin privileges.

When set to true, generates temporary URLs for the resources returned by the service provider as part of their response. The URLs are valid for 300 seconds. The API user must have sufficient access permission:

1. To access viewable eFolder files, the user must have loan access (and document access if configured).

2. For native file formats, the user needs both loan access and an admin/super admin persona.

For more information about the Resource_Transaction object, see the Resource_Transaction attributes table.

For Freddie Mac DataShare APIs, this (optional, value should be True) parameter should be passed only if you need download URLs for attachments.

Response

200OK