Validate SIM cards registration codes

POST 
/sim_cards/actions/validate_registration_codes

It validates whether SIM card registration codes are valid or not.

Request

application/json

Body

required

registration_codes string[]

Responses

200: Successful

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

record_type string

registration_code string

The 10-digit SIM card registration code

valid boolean

The attribute that denotes whether the code is valid or not

invalid_detail stringnullable

The validation message

]

{
  "data": [
    {
      "record_type": "sim_card_registration_code_validation",
      "registration_code": "0123456789",
      "valid": false,
      "invalid_detail": "This code has already been used."
    }
  ]
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/sim_cards/actions/validate_registration_codes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "registration_codes": [
    "123456780",
    "1231231230"
  ]
}'

Response samples

• 200
• default

---

{
  "data": [
    {
      "record_type": "sim_card_registration_code_validation",
      "registration_code": "0123456789",
      "valid": false,
      "invalid_detail": "This code has already been used."
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}