SellerDetailedSearch Calls

This endpoint will retrieve a Seller Report for the merchant that most closely matches the submitted inputs. The report will be sent asynchronously to the provided callback URL once data from external sources has been processed.

Requirements

• A callback URL is required to receive the completed Seller Report. The callback URL must correspond to a live, accessible REST endpoint that accepts POSTs containing the generated Seller Report payload

Response

• Returns a request_id that can be used to:

  • Monitor request status via the SellerDetailedStatus endpoint.

  • Retrieve the final report via the SellerDetailedResult endpoint (as an alternative to the callback).

Request Syntax

{

    "name": "string",              // required
    "alt_name": "string",          // optional
    "address_line_1": "string",    // required
    "address_line_2": "string",    // optional 
    "city": "string",              // required
    "state": "string",             // required
    "zip5": "string",              // required
    "zip4": "string",              // optional
    "dpc": "string",               // optional
    "ein": "string",               // optional
    "phone": "string",             // optional
    "alt_phone": "string",         // optional
    "fax": "string",               // optional
    "email": "string",             // optional
    "domain_name": "string",       // optional
    "callback": "string"           // required

}

Response

A successful call will generate a response that contains the status of the request and a request_id. The full Seller Report will be returned to the callback URL once the status returns complete.

{

    "status":     "string",
    "request_id": "uuid"

}

For more detailed API Specifications, please see our API Reference Guide > Seller Detailed Search