User Verification

Download schema

Verify code

POST

https://dev.api.radarbov.app

/api/users/{user_id}/verification/verify_code

Verify code › path Parameters

user_id

string · required

Verify code › Request Body

User Verification Verify Code

str_verification_code

string

user_id

string · uuid

Verify code › Responses

Resend code

POST

https://dev.api.radarbov.app

/api/users/{user_id}/verification/resend_code

Resend code › path Parameters

user_id

string · required

Resend code › Request Body

User Verification Resend Code

method

string

Resend code › Responses

User · required

POST/api/users/{user_id}/verification/resend_code

curl https://dev.api.radarbov.app/api/users/:user_id/verification/resend_code \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "method"
}'

Example Request Body

{
  "method": "method"
}

json

Example Responses

{
  "data": {
    "bl_active": true,
    "bl_admin": true,
    "bl_cancelled": true,
    "bl_org_admin": true,
    "county": {
      "id": "00000000-0000-0000-0000-000000000000",
      "str_federative_unit": "str_federative_unit",
      "str_ibge_code": "str_ibge_code",
      "str_name": "str_name",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "str_document": "str_document",
    "str_email": "str_email",
    "str_name": "str_name",
    "str_phone": "str_phone",
    "str_status": "str_status",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Request

POST

https://dev.api.radarbov.app

/api/users/verification/request

Request › Request Body

User Verification Request

method

string

str_document

string

str_email

string

str_phone

string

Request › Responses

Created

User · required

POST/api/users/verification/request

curl https://dev.api.radarbov.app/api/users/verification/request \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "method",
  "str_document": "str_document",
  "str_email": "str_email",
  "str_phone": "str_phone"
}'

Example Request Body

{
  "method": "method",
  "str_document": "str_document",
  "str_email": "str_email",
  "str_phone": "str_phone"
}

json

Example Responses

{
  "data": {
    "bl_active": true,
    "bl_admin": true,
    "bl_cancelled": true,
    "bl_org_admin": true,
    "county": {
      "id": "00000000-0000-0000-0000-000000000000",
      "str_federative_unit": "str_federative_unit",
      "str_ibge_code": "str_ibge_code",
      "str_name": "str_name",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "str_document": "str_document",
    "str_email": "str_email",
    "str_name": "str_name",
    "str_phone": "str_phone",
    "str_status": "str_status",
    "str_type": "str_type",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

User Features Vehicle

Verify code

POST

https://dev.api.radarbov.app

/api/users/{user_id}/verification/verify_code

Verify code › path Parameters

user_id

string · required

Verify code › Request Body

User Verification Verify Code

str_verification_code

string

user_id

string · uuid