Skip to content

Compliance API's


API Name Description
Submit RequestCreates a new draft or submission in Advertising Review. This call supports file attachments, and the JSON payload should be sent as an attachment.
Resubmit RequestCreates a new draft or submission as a new version or instance of the original submission. Your firm may call this making a “clone” or “copy” of a submission, as this Resubmit functionality can be renamed in the Advertising Review application. This call supports file attachments, and the JSON payload should be sent as an attachment.
Submit RevisionUpdates a submission in a particular workflow step, moving the submission to the next workflow step while potentially adding a revision comment and/or file attachment(s). The ability to use this call is dependent on specific configurations that a RegEd Implementation Consultant must make in your firm’s workflow, and these configurations can only be made at specific steps. This call is designed to allow a web service call to update a submission that has been given a “Revise and Resubmit” decision.
Update SubmissionUpdates metadata values in an existing submission or draft. For any pre -defined value in AdTrax, the external id value is expected.
Add FilesAdds review item, additional document, and supporting document file attachments to an existing submission or draft.
Convert DraftConverts an existing draft into an active submission.
Get Item DetailsRetrieves submission details for one or more tracking numbers. This call can be used to retrieve submission values that may be needed in other calls.
Get Changed ItemsReturns submission details for any submissions that were changed during the datetime range provided. The data elements returned in this call are the same as those returned in the Get Item Details call.
Get Review ItemsReturns a “review item” file for a given submission tracking number and file id.
Get DocumentReturns an “additional document” file for a given submission tracking number and file id.
Get AnnotationsReturns a PDF file containing “review item” annotations for a given submission tracking number, file id, and file version. If the “review item” has not been annotated, the call will return an error message.
Get FINRA DetailsReturns a submission’s FINRA filing details for a given tracking number. This includes the FINRA decision, if available.
Get FINRA LetterReturns a FINRA letter PDF file for a given submission and id.