Skip to main content

Lookup

The "Lookup" endpoint is used to perform a data lookup request for use in an API session. This endpoint requires bearer authentication, which means the client must provide a valid authentication token in the request headers to access this endpoint.

Request​

To use the "Lookup" endpoint, the client needs to make a POST request to Link
The request body should include the following required parameter:

  • module: The lookup module to return. Available values are currency, country, productcatalogue, and provider.
{
  "module": "country"
}

Response​

When the "Lookup" endpoint is called with valid authentication and request parameters, the MPSMS API will respond with a JSON payload containing the following fields:

  • success: A boolean value indicating whether the request was successful or not.
  • code: An integer value representing the HTTP status code of the response.
  • message: A string message providing additional information about the response.
  • data: An object containing the data returned from the lookup request.
  • trackid: The unique identifier for the current request, which can be used for logging and troubleshooting purposes.
  • stamp: An integer timestamp representing the current time when the response was generated.
{
  "success": true,
  "code": 0,
  "message": "OK",
  "stamp": "2026-09-07T09:08:26+00:00",
  "trackid": "<uuid>",
  "data": {
    "rc": 5,
    "sd": [
      {
        "nam": "Cote D'Ivoire",
        "rid": 4
      },
      {
        "nam": "Default",
        "rid": 0
      },
      {
        "nam": "Ghana",
        "rid": 1
      },
      {
        "nam": "Nigeria",
        "rid": 3
      },
      {
        "nam": "United States",
        "rid": 5
      }
    ]
  }
}

By using the "Lookup" endpoint, clients can retrieve additional data or information required for their API service integrations with the MPSMS platform.