Skip to main content
POST
/
verification-sms
/
send-registration-code
Send Verification Code For Account Activation
curl --request POST \
  --url https://apigw.bienport.com/api/verification-sms/send-registration-code \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'OrganizationId: <organizationid>' \
  --data '{
  "screenName": "12343123"
}'
{
  "status": false,
  "user": {
    "userId": 123,
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "screenName": "<string>",
    "nationalId": 123,
    "organizations": [
      {
        "name": "<string>",
        "id": 123
      }
    ],
    "organizationIds": [
      123
    ],
    "modifiedDate": 123,
    "languageId": "<string>",
    "failedLoginAttempts": 123,
    "status": 123,
    "emailAddress": "<string>",
    "timeZoneId": "<string>",
    "contactId": 123,
    "lockout": true,
    "roles": [
      {
        "roleId": 123,
        "roleName": "<string>",
        "type": 123,
        "inherited": true,
        "typePK": 123,
        "typeName": "<string>"
      }
    ],
    "resources": [
      {
        "resourceId": 123,
        "networkId": "<string>",
        "resourceName": "<string>",
        "enabled": true,
        "modelName": "<string>",
        "brandName": "<string>",
        "treePath": "<string>",
        "orgId": 123,
        "resourceSensors": [
          {
            "type": "<string>",
            "sensors": [
              {
                "id": 123,
                "resourceId": 123,
                "orderNo": 123,
                "ioType": "Digital",
                "ioDirection": "Input",
                "trueValue": "<string>",
                "falseValue": "<string>",
                "partitions": [
                  {
                    "name": "<string>",
                    "no": 123
                  }
                ],
                "sensorId": 123,
                "description": "<string>",
                "hardwareSerialNumber": "<string>",
                "sensorName": "<string>"
              }
            ]
          }
        ],
        "resourceControllers": [
          {
            "hardwareSerialNumber": "<string>",
            "id": 123,
            "resourceId": 123,
            "orderNo": 123,
            "ioType": "Digital",
            "ioDirection": "Input",
            "trueValue": "<string>",
            "falseValue": "<string>",
            "description": "<string>",
            "controllerName": "<string>",
            "controllerId": 123,
            "partitions": [
              {
                "name": "<string>",
                "no": 123
              }
            ]
          }
        ],
        "resourceSubscriptionId": 123,
        "subscriptionDocumentNo": "<string>",
        "resourceType": "Device",
        "deviceSubType": "<string>"
      }
    ]
  },
  "message": "SMS sent. / SMS not sent.",
  "userId": 235234
}

Headers

Authorization
string
required

Access Token

OrganizationId
string
required

Organization ID

Body

application/json

sendVerificationCodeRequest

Send Verification Code Request Model

screenName
string

Screen Name

Example:

"12343123"

Response

Verification process feedback

status
boolean

The sending status of the SMS.

Example:

false

user
object

Add User response model

message
string

The sending message of the SMS.

Example:

"SMS sent. / SMS not sent."

userId
integer

User ID. ( If a verification code is requested again, it will return. )

Example:

235234