# Parameters source: https://developer.mastercard.com/track-search/documentation/parameters/index.md ## POST/bulk-searches {#postbulk-searches} ### Body Parameters {#body-parameters} | Parameter | Description | Required | Type | Example | |-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------|-------------------------------------------------| | lookupType | Type of entity being queried, either BUYERS or SUPPLIERS. | Yes | string | SUPPLIERS | | maximumMatches | Maximum number of matches from one to five to be returned per submitted record. Default value is 1. | No | integer(32) | 2 | | minimumConfidenceThreshold | Minimum confidence score to be considered a match in the results. The minimum value is 0 and maximum value is 1. | No | Double | 0.6 | | requestingEntity | Details of the entity for which the search is being conducted. Should not provide details of individual persons and sole proprietors. | No | object | | | bpsProfileId | Business Payment Service profile identification of the entity for which the search is being conducted. | No | string | entity@track | | businessAddress | Business address details of the entity for which the search is being conducted. | No | object | | | addressLine1 | Line 1 business address details of the entity for which the search is being conducted. Should include line 2 and line 3 details if available. | No | string | 10 Main St, Apt 3 | | country | Three letter country code of the entity for which the search is being conducted. | No | string | USA | | countrySubDivision | Two-character country sub-division code (state or province) of the entity for which the search is being conducted. Required for entities in USA, Canada, and Australia. | No | string | NY | | postCode | Post code of the entity for which the search is being conducted. | No | string | 10577 | | townName | Town or city name of the entity for which the search is being conducted. | No | string | Los Angeles | | businessName | Business name of the entity for which the search is being conducted. Should not provide names of individuals and sole proprietors. | No | string | Starbucks, Inc. | | emailAddress | Email address of the entity for which the search is being conducted. Should not provide individual email addresses. | No | string | [info@starbucks.com](mailto:info@starbucks.com) | | organisationIdentifications | Organization identification details of the entity for which the search is being conducted. | No | object | | | identification | Organization identification of the entity for which the search is being conducted. | No | string | 123456789 | | type | The code for the type of organization identification submitted. | No | string | TXID | | phoneNumber | Phone number of the entity for which the search is being conducted. Should not provide phone number of individuals and sole proprietors. | No | string | 0123456789 | | searches | Details about the entity being searched for. Should not provide details of individuals and sole proprietors. | Yes | object | | | annualInvoiceCount | Annual number of invoices between the entity for which the search is being conducted and the entity being searched for. | No | string | 1000 | | annualNumberOfTransactions | Annual number of transactions between the entity for which the search is being conducted and the entity being searched for. | No | string | 500 | | annualTransactionAmount | The total annual value of transactions between the entity for which the search is being conducted and the entity being searched for. | No | string | 100000 | | businessAddress | Business address details of the entity being searched for. | Yes | object | | | addressLine1 | Line 1 address details of the entity being searched for. Should include line 2 and line 3 details if available. | No | string | | | country | Three letter country code of the entity being searched for. | No | string | USA | | countrySubDivision | Two-character country sub-division code (state or province) of the entity being searched for. | No | string | NY | | postCode | Post code of the entity being searched for. | No | string | | | townName | Town or city name of the entity being searched for. | No | string | Los Angeles | | businessName | Business name of the entity being searched for. Should not provide names of individuals and sole proprietors. | No | string | Starbucks, Inc. | | currency | The three-letter currency code of the annualTransactionAmount. | No | string | USD | | emailAddress | Official email address of the entity being searched for. Should not use individual email addresses. | No | string | [info@starbucks.com](mailto:info@starbucks.com) | | organisationIdentifications | Organization identification details of the entity being searched for. | No | object | | | identification | Organization identification of the entity being searched for. | No | string | 123456789 | | type | The code for the type of organization identification submitted. | No | string | TXID | | paymentMethod | Mode of payment between the entity for which the search is being conducted and the entity being searched for. | No | string | CARD | | paymentTerms | Payment terms and conditions between the entity for which the search is being conducted and the entity being searched for. | No | string | Next 30 days | | phoneNumber | Official phone number of the entity being searched for. Should not provide phone number of individuals and sole proprietors. | No | string | 0156450789 | | searchRequestId | A user created end-to-end Identification for the entity being searched for. Must be unique within a request. | Yes | string | 12345-abcdefg-6789 | ### Response Body Parameters {#response-body-parameters} | Parameter | Description | Required | Type | Example | |--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|--------|--------------------------------------| | bulkSearchId | Service generated Identification for your bulk search API call. You use this ID to check the status for your bulk search request and retrieve your search results. | Yes | string | 4b4961a2-2fd2-4308-813c-8b1f08503d9f | ## GET/bulk-searches/{bulk_search_id} {#getbulk-searchesbulk_search_id} ### Path Parameter {#path-parameter} | Parameter | Description | Required | Type | |----------------|-------------------------------------------------------------------------------------------|----------|--------| | bulk_search_id | The service generated Identification received in the response of your POST/bulk-searches. | Yes | string | ### Response Body Parameter {#response-body-parameter} | Parameter | Description | Required | Type | |-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|------| | status | The status of initiated bulk search request. * COMPLETED: The bulk search is completed. You can retrieve the bulk search results. * PENDING: The bulk search is still in progress. * ERROR: There has been an error while processing the search. | Yes | | ## GET/bulk-searches/{bulk_search_id}/results {#getbulk-searchesbulk_search_idresults} ### Path Parameter {#path-parameter-1} | Parameter | Description | Required | Type | |----------------|-------------------------------------------------------------------------------------------|----------|--------| | bulk_search_id | The service generated Identification received in the response of your POST/bulk-searches. | Yes | string | ### Query Parameters {#query-parameters} | Parameter | Description | Required | Type | Example | |-----------|-----------------------------------------------------------------------------------------------------------------------|----------|---------|---------| | offset | The number of items to skip before selecting the row to return. The default value is 0, which selects the first item. | No | integer | 100 | | limit | The maximum number of items to be returned. Default value is 25. The maximum value is 100. | No | integer | 25 | ### Response Body Parameters {#response-body-parameters-1} | Parameter | Description | Required | Type | Example | |-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-------------|--------------------------------------| | count | The number of items returned in this iteration of the search results retrieval. | Yes | integer(32) | 10 | | offset | The number of items skipped as specified. | Yes | integer(32) | 50 | | limit | The maximum number of items to be returned as specified. | Yes | integer(32) | 25 | | total | The total number of items that can be returned for this bulk_search_id. | Yes | integer(32) | 60 | | items | Details of the search results. | Yes | array | | | bpsRegistrationId | The Business Payment Service registration GUID to be used in the Linking process. | No | string | 4b4961a2-2fd2-4308-813c-8b1f08503d9f | | confidence | The confidence of the match found (HIGH, MEDIUM, or LOW). | No | string | High | | searchRequestId | The user created end-to-end ID for the entity being searched for in the POST/bulk-searches. | Yes | string | 12345-abcdefg-6789 | | searchResult | Details of the search results. | Yes | object | | | bpsDetails | Business Payment Service details of the matched entity (Only available for Business Payment Service agents). | No | object | | | a2aEnabled | Indicator showing if the matched entity is enabled for account-to-account transactions in Business Payment Service. | No | boolean | true | | a2aPreferences | The account-to-account payment preferences of the matched entity. | No | array | \[FEE, TIME\] | | a2aRecency | Indicates how recently the matched entity had an account-to-account transaction in Business Payment Service. | No | string | 1 month | | cardEnabled | Indicator showing if the matched entity is enabled for card transactions in Business Payment Service. | No | boolean | true | | cardPreferences | The account-to-account payment preferences of the matched entity. | No | array | \[FEE, TIME\] | | cardRecency | Indicates how recently the matched entity had an account-to-account transaction in Business Payment Service. | No | string | 1 month | | transactionEnabled | Indicator showing if the matched entity is enabled for transactions in Business Payment Service. | No | boolean | true | | cardProcessingHistory | Details of the matched entity inferred from card transaction history. **Note: These details are provided only for Supplier entities.** | No | object | | | commercialHistory | Indicator showing if the matched Supplier processed a Mastercard Commercial Card payment. | No | string | Y | | commercialRecency | Indicates how recently the matched Supplier processed a Mastercard Commercial Card payment. | No | string | 1 month | | inControlHistory | Indicator showing if the matched Supplier processed a payment from an In Control generated virtual card. | No | string | Y | | inControlRecency | Indicates how recently the Supplier processed a payment from an In Control generated virtual card. | No | string | 1 month | | mcc | Merchant category code of the matched Supplier. | No | integer(32) | 1711 | | mccGroup | Merchant category code group of the matched Supplier. | No | string | Service Providers | | purchaseCardLevel | The maximum number of purchase addenda included by the matched Supplier. Two purchase addenda may qualify a transaction for Level 3 interchange, one purchase addendum may qualify a transaction for Level 2 interchange, and zero addenda may qualify a transaction for Level 1 interchange. | No | integer(32) | 0 | | smallBusiness | Indicator showing if the Supplier a small business (US Only). | No | string | Y | | transactionRecency | Indicates how recently the matched Supplier processed a Mastercard Card payment. | No | string | 1 month | | nonProfit | Indicator showing if the Supplier is non-profit (US Only). | No | string | N | | minorityOwned | Indicator showing if the Supplier is minority owned (US Only). | No | string | Y | | nonProfit | Indicator showing if the Supplier is a non-profit (US Only). | No | string | N | | womenOwned | Indicator showing if the Supplier is women owned (US Only). | No | string | N | | entityDetails | Details of the matched entity. | No | object | | | businessAddress | Address details of the matched entity. | No | object | | | addressLine1 | Address details of the matched entity. | No | string | 10 Main St, Apt 3 | | country | Three-letter country code of the matched entity. | No | string | USA | | countrySubDivision | Two-character country sub-division code (e.g. state or province) of the matched entity. | No | string | NY | | postCode | Post code of the matched entity. | No | string | 10577 | | townName | Town, or city, name of the matched entity. | No | string | Los Angels | | businessName | Name of the matched entity. | No | string | Starbucks, Inc. | | merchantIds | IDs of the matched entity in the merchant database. | No | array(64) | 7732345 | | organisationIdentifications | Organization identification details of the matched entity. | No | object | | | identification | Organisation identification of the matched entity. | No | string | 123456789 | | type | The code for the type of organisation identification. | No | string | TXID | | phoneNumber | Phone number of the matched entity. | No | string | 0123456789 | | errors | Object showing any errors associated with a submitted entity. If this object exists, bpsDetails, cardProcessingHistory, and entityDetails will not be populated. | No | object | | | description | Description of the error. | No | string | Country Code is required | | reasonCode | Error reason code. | No | string | R09 |