/Docs · REST API v1.2.0

API reference.

Base URL https://programmatic-api.client.get.mymfa.io/v1. Authenticate every call with your API key in the x-api-key header. Available on the Pro and Enterprise plans.

Get an API key Download OpenAPI JSON Framework tutorials

Authentication

Every request is a plain HTTPS GET against https://programmatic-api.client.get.mymfa.io/v1, authenticated with the API key from the API section of your GetMyMFA console in the x-api-key header. The API is available on the Pro and Enterprise plans; the two full-message endpoints are Enterprise only. Error responses are JSON objects with a single message field.

curl "https://programmatic-api.client.get.mymfa.io/v1/phone-numbers" \
  -H "x-api-key: <your-api-key>"

Endpoint	Returns	Plan
GET /phone-numbers	Get your phone numbers	Pro & Enterprise
GET /{phone_id}/mfa/latest	Get last MFA code for given phone number	Pro & Enterprise
GET /{phone_id}/message/latest	Get last full body message for given phone number	Enterprise
GET /email-addresses	Get your email addresses	Pro & Enterprise
GET /{email_id}/mfa/latest	Get last MFA code for given email address	Pro & Enterprise
GET /{email_id}/message/latest	Get last full body message for email address	Enterprise

Everything about your phone numbers

GET/phone-numbersPro & Enterprise

Get your phone numbers

Retrieve the list of phone numbers that you have purchased

Parameters

Name	In	Description
x-api-keyrequired	header	Your programmatic API Key

Request

curl -X GET "https://programmatic-api.client.get.mymfa.io/v1/phone-numbers" \
  -H "x-api-key: <your-api-key>"

Responses

200Success · PhoneNumbers
400Invalid query provided · Error400
403User is not authorized to perform this request · Error403

Example 200 response

{
  "count": 9,
  "remainingPurchaseQuota": 1,
  "phoneNumbers": [
    {
      "phoneId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
      "phoneNumber": "+1123123123",
      "country": "United States",
      "capabilities": [
        "International",
        "Limited"
      ]
    }
  ]
}

Access your phone number messages or MFA codes

GET/{phone_id}/mfa/latestPro & Enterprise

Get last MFA code for given phone number

Given a phone ID, retrieve the last MFA code received (valid).

Parameters

Name	In	Description
x-api-keyrequired	header	Your personal API Key
phone_idrequired	path	The phone number ID for which you want to retrieve the last MFA code

Request

curl -X GET "https://programmatic-api.client.get.mymfa.io/v1/<phone_id>/mfa/latest" \
  -H "x-api-key: <your-api-key>"

Responses

200Success · PhoneMfaCode
400Invalid query provided · Error400
403User is not authorized to perform this request · Error403
404Phone number not found · Error404

Example 200 response

{
  "phoneId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
  "phoneNumber": "+1123123123",
  "mfaCode": "182937",
  "receivedDate": 1672534861,
  "limitsData": {
    "smsLimit": 100,
    "consumptionRate": 0.88,
    "consumptionAmount": 88,
    "periodStart": 1707041609,
    "periodEnd": 1709547209
  }
}

GET/{phone_id}/message/latestEnterprise

Get last full body message for given phone number

Given a phone ID, retrieve the last full body message received.

Parameters

Name	In	Description
x-api-keyrequired	header	Your personal API Key
phone_idrequired	path	The phone number ID for which you want to retrieve the last SMS message

Request

curl -X GET "https://programmatic-api.client.get.mymfa.io/v1/<phone_id>/message/latest" \
  -H "x-api-key: <your-api-key>"

Responses

200Success · Message
400Invalid query provided · Error400
403User is not authorized to perform this request · Error403
404Phone number not found · Error404

Example 200 response

{
  "phoneId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
  "phoneNumber": "+1123123123",
  "message": "In order to login, please visit https://example.com",
  "receivedDate": 1672534861,
  "limitsData": {
    "smsLimit": 100,
    "consumptionRate": 0.88,
    "consumptionAmount": 88,
    "periodStart": 1707041609,
    "periodEnd": 1709547209
  }
}

Everything about your virtual email addresses

GET/email-addressesPro & Enterprise

Get your email addresses

Retrieve the list of email addresses that you have purchased

Parameters

Name	In	Description
x-api-keyrequired	header	Your programmatic API Key

Request

curl -X GET "https://programmatic-api.client.get.mymfa.io/v1/email-addresses" \
  -H "x-api-key: <your-api-key>"

Responses

200Success · EmailAddresses
400Invalid query provided · Error400
403User is not authorized to perform this request · Error403

Example 200 response

{
  "count": 9,
  "remainingPurchaseQuota": 1,
  "emailAddresses": [
    {
      "emailId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
      "emailAddress": "b6af7ed@client.get.mymfa.io"
    }
  ]
}

Access your email address messages or MFA codes

GET/{email_id}/mfa/latestPro & Enterprise

Get last MFA code for given email address

Given an email address ID, retrieve the last MFA code received (valid).

Parameters

Name	In	Description
x-api-keyrequired	header	Your personal API Key
email_idrequired	path	The email address ID for which you want to retrieve the last MFA code

Request

curl -X GET "https://programmatic-api.client.get.mymfa.io/v1/<email_id>/mfa/latest" \
  -H "x-api-key: <your-api-key>"

Responses

200Success · EmailMfaCode
400Invalid query provided · Error400
403User is not authorized to perform this request · Error403
404Phone number not found · Error404

Example 200 response

{
  "emailId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
  "emailAddress": "+1123123123",
  "mfaCode": "182937",
  "receivedDate": 1672534861,
  "limitsData": {
    "smsLimit": 100,
    "consumptionRate": 0.88,
    "consumptionAmount": 88,
    "periodStart": 1707041609,
    "periodEnd": 1709547209
  }
}

GET/{email_id}/message/latestEnterprise

Get last full body message for email address

Given an email address ID, retrieve the last full body message received.

Parameters

Name	In	Description
x-api-keyrequired	header	Your personal API Key
email_idrequired	path	The phone number ID for which you want to retrieve the last SMS message

Request

curl -X GET "https://programmatic-api.client.get.mymfa.io/v1/<email_id>/message/latest" \
  -H "x-api-key: <your-api-key>"

Responses

200Success · Message
400Invalid query provided · Error400
403User is not authorized to perform this request · Error403
404Phone number not found · Error404

Example 200 response

{
  "phoneId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
  "phoneNumber": "+1123123123",
  "message": "In order to login, please visit https://example.com",
  "receivedDate": 1672534861,
  "limitsData": {
    "smsLimit": 100,
    "consumptionRate": 0.88,
    "consumptionAmount": 88,
    "periodStart": 1707041609,
    "periodEnd": 1709547209
  }
}

Schemas

Response bodies. Dates are Unix timestamps in seconds; limitsData describes the SMS quota of the current billing period.

›PhoneNumbers

Field	Type	Example
count	number	9
remainingPurchaseQuota	number	1
phoneNumbers	array of PhoneNumber

{
  "count": 9,
  "remainingPurchaseQuota": 1,
  "phoneNumbers": [
    {
      "phoneId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
      "phoneNumber": "+1123123123",
      "country": "United States",
      "capabilities": [
        "International",
        "Limited"
      ]
    }
  ]
}

›EmailAddresses

Field	Type	Example
count	number	9
remainingPurchaseQuota	number	1
emailAddresses	array of EmailAddress

{
  "count": 9,
  "remainingPurchaseQuota": 1,
  "emailAddresses": [
    {
      "emailId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
      "emailAddress": "b6af7ed@client.get.mymfa.io"
    }
  ]
}

›PhoneNumber

Field	Type	Example
phoneId	string	74b05a20-d3f9-4179-9bdc-d93e1c6bca88
phoneNumber	string	+1123123123
country	string	United States
capabilities	array of string	International, Limited, Numeric, Multi-Sender, Short, Trial

{
  "phoneId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
  "phoneNumber": "+1123123123",
  "country": "United States",
  "capabilities": [
    "International",
    "Limited"
  ]
}

›EmailAddress

Field	Type	Example
emailId	string	74b05a20-d3f9-4179-9bdc-d93e1c6bca88
emailAddress	string	b6af7ed@client.get.mymfa.io

{
  "emailId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
  "emailAddress": "b6af7ed@client.get.mymfa.io"
}

›PhoneMfaCode

Field	Type	Example
phoneId	string	74b05a20-d3f9-4179-9bdc-d93e1c6bca88
phoneNumber	string	+1123123123
mfaCode	string	182937
receivedDate	number	1672534861
limitsData	object
limitsData.smsLimit	number	100
limitsData.consumptionRate	number	0.88
limitsData.consumptionAmount	number	88
limitsData.periodStart	number	1707041609
limitsData.periodEnd	number	1709547209

{
  "phoneId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
  "phoneNumber": "+1123123123",
  "mfaCode": "182937",
  "receivedDate": 1672534861,
  "limitsData": {
    "smsLimit": 100,
    "consumptionRate": 0.88,
    "consumptionAmount": 88,
    "periodStart": 1707041609,
    "periodEnd": 1709547209
  }
}

›EmailMfaCode

Field	Type	Example
emailId	string	74b05a20-d3f9-4179-9bdc-d93e1c6bca88
emailAddress	string	+1123123123
mfaCode	string	182937
receivedDate	number	1672534861
limitsData	object
limitsData.smsLimit	number	100
limitsData.consumptionRate	number	0.88
limitsData.consumptionAmount	number	88
limitsData.periodStart	number	1707041609
limitsData.periodEnd	number	1709547209

{
  "emailId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
  "emailAddress": "+1123123123",
  "mfaCode": "182937",
  "receivedDate": 1672534861,
  "limitsData": {
    "smsLimit": 100,
    "consumptionRate": 0.88,
    "consumptionAmount": 88,
    "periodStart": 1707041609,
    "periodEnd": 1709547209
  }
}

›Message

Field	Type	Example
phoneId	string	74b05a20-d3f9-4179-9bdc-d93e1c6bca88
phoneNumber	string	+1123123123
message	string	In order to login, please visit https://example.com
receivedDate	number	1672534861
limitsData	object
limitsData.smsLimit	number	100
limitsData.consumptionRate	number	0.88
limitsData.consumptionAmount	number	88
limitsData.periodStart	number	1707041609
limitsData.periodEnd	number	1709547209

{
  "phoneId": "74b05a20-d3f9-4179-9bdc-d93e1c6bca88",
  "phoneNumber": "+1123123123",
  "message": "In order to login, please visit https://example.com",
  "receivedDate": 1672534861,
  "limitsData": {
    "smsLimit": 100,
    "consumptionRate": 0.88,
    "consumptionAmount": 88,
    "periodStart": 1707041609,
    "periodEnd": 1709547209
  }
}

›Error400

Field	Type	Example
message	string	Malformed request

{
  "message": "Malformed request"
}

›Error403

Field	Type	Example
message	string	Unauthorized

{
  "message": "Unauthorized"
}

›Error404

Field	Type	Example
message	string	Not found

{
  "message": "Not found"
}