Start Registration

Begins the account registration flow. Sends a 6-digit activation code to the provided email address. The code is valid for 15 minutes.

Submit the code to POST /account/register/verify to complete registration and receive your API key.

This endpoint does not require authentication.

POST /account/register

Start Registration

cURL

curl --request POST \
  --url https://api.mintfax.com/v1/account/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "[e-mail]"
}
'

200

{
  "email": "[e-mail]",
  "message": "<string>",
  "expires_in": 123
}

Authorizations

Authorization · string · header · required

API key as Bearer token. Use an account key (mfx_acct_...) for /account/* endpoints, and an environment key (mfx_test_... for sandbox, mfx_live_... for live) for /environment/*, /faxes, /webhooks, and /events.

Body

application/json

name · string · required

Maximum string length: 255

email · string<email> · required

Maximum string length: 255

Response

200

application/json

RegistrationInitiatedResource

email · string<email> · required

The email address the activation code was sent to.

Example:

"[e-mail]"

message · string · required

Human-readable confirmation message.

Example:

"Activation code sent. Valid for 15 minutes."

expires_in · integer · required

Seconds until the activation code expires.

Example:

900