Skip to Content
MID 1.0 is released 🎉

Authentication

API Key

Authentication The MID API uses API keys to authenticate requests. You can view and manage your API keys in the MID Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas.

Authenticated Request Server-side language

curl -X 'GET' \
        'http://api.mobid.io/v1/health' \
     -H 'X-Mobid-Key: qk_63ccde4e11274c33b9255224':

The colon prevents curl from asking for a password. Your API Key A sample test API key is included in all the examples here, so you can test any example right away. Do not submit any personally identifiable information in requests made with this key.

To test requests using your account, replace the sample API key with your actual API key or sign in.

Errors

MID uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with MID’s servers (these are rare).

Attributes

code nullable string For some errors that could be handled programmatically, a short string indicating the error code reported.

message nullable string A human-readable message providing more details about the error.

data nullable object Response details of the expected outcome in json.

HTTP Status Code Summary

  • 200 OK Everything worked as expected.
  • 400 Bad Request The request was unacceptable, often due to missing a required parameter.
  • 401 Unauthorized No valid API key provided.
  • 402 Request Failed The parameters were valid but the request failed.
  • 403 Forbidden The API key doesn’t have permissions to perform the request.
  • 404 Not Found The requested resource doesn’t exist.
  • 409 Conflict The request conflicts with another request (perhaps due to using the same idempotent key).
  • 429 Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
  • 500, 502, 503, 504 Server Errors Something went wrong on MID’s end. (These are rare.)
Last updated on