Seller Detailed Search Implementation

The SellerDetailedSearch API call slightly differs from the SellerSearch API call in that it requires a callback URL and will actively reach out to grab updated Bankruptcy, Lien, and Judgement Data and Corporate Filing data if the client has those packages outlined in their contract. The SellerReport payload with updated data will be sent back to the client's callback endpoint.

Workflow: SellerDetailedSearch -> SellerDetailedStatus -> SellerDetailedResult

  • The client will submit all of the same fields they would in the SellerSearch call (business name, address, city, state, zip5) except two new fields. The first new parameter is a callback URL that is required so we can send back the fully updated merchant report back when complete. The second new parameter in this call relates to Bankruptcy, Lien, and Judgement data – there is a “detailed_info” optional parameter that can be true/false on whether they want to reach out to level 2 BLJ data (its false by default if not passed in the payload) – or the specifics of bankruptcies, liens, and judgements if they are available. For example, if there is any current BLJ data for a seller, it will always have a summary object. This summary object has the # of counts of liens, judgements, and bankruptcies. This is what we consider "level 1 BLJ data" or what is returned when detailed_info=False. If there are counts > 0 for any of those fields and the client wants to grab detailed info about them, the client can then reach out for "level 2 BLJ data" that will have specific info on bankruptcies, liens, or judgements for a seller. The clients have this option because it costs more to get the additional BLJ data.

  • The return of the SellerDetailedSearch call is the status of the request and a request_id. This request_id can be used to check on the status of a request using the Seller Detailed Status call, that will say whether the request is still in progress, or if complete -- it will have a status of “complete” and a redirect URL to the SellerDetailedResult call. Even though we have a callback that will automatically send back the merchant report once the request is complete – just in case it fails to hit the client’s endpoint or they want to grab the merchant report directly from the api, they can use the request_id mentioned above for the SellerDetailedResult call to get the SellerReport back as well.

Extra things to consider:

  • The normal SellerSearch call will also have corporate filing data or the BLJ data if it already exists in our database, it will not actively reach out for new/updated data.

  • The field in the SellerReport for BLJ data is called "blj" and the field for Corporate Filing data is called "secretary_of_state."

  • Reaching out for business third party BLJ data will return "principal" objects that are eligible for additional third party data on each individual. You can use the principal_ids that are in this array for the Principal Third Party Data calls to grab additional data for each principal.

Last updated