Skip to content
Xaalis

Test mode: issue a fixed-code OTP challenge without sending SMS

POST
/v1/public/exchanges/otp
curl --request POST \
  --url http://localhost:4000/v1/public/exchanges/otp \
  --header 'Content-Type: application/json' \
  --data '{ "phone": "+221771234567" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
phone
required
string
/^\+2217[0-9]{8}$/
Example
+221771234567

Responses

Section titled “ Responses ”

200

Section titled “200”

Test OTP

Media typeapplication/json
object
sent
required
boolean
test_code
required
string
expires_at
required
string
Examplegenerated
{
  "sent": true,
  "test_code": "example",
  "expires_at": "example"
}

400

Section titled “400”

Invalid input

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403”

Test mode disabled

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Section titled “409”

Invalid or reused quote

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422”

Limit exceeded

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Section titled “429”

Rate limited

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

503

Section titled “503”

Unavailable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}