Verify OTP code
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Serializer for OTP verification.
Fields
- phone_number
Type: string
Required: Yes
Length: ≤ 50 - otp_code
Type: string
Required: Yes
Length: ≤ 10 - subdomain
Type: string
Required: Yes
Length: ≤ 255 - invite_token
Type: string
Length: ≤ 64 - content-type
Type: string
Enum values:
Defaults to application/json
Allowed:application/json,application/x-www-form-urlencoded,multipart/form-data
Response Codes
200: OTP verified successfully400: Invalid OTP code401: OTP expired or invalid
Serializer for token response.
Fields
- token
Type: string
Required: Yes - phone_number
Type: string
Required: Yes - status
Type: string
Required: Yes - person
Type: object | null
Serializer for Person model.
Serializer for Person model
Fields
- id
Type: string
Required: Yes - preferred_name
Type: string
Required: Yes
Length: ≤ 255
The preferred name for this person - email_address
Type: string | null
Email address for this person - phone_number
Type: string
Required: Yes - role
Type: string
Enum values:CLIENT,CO_CLIENT,FAMILY_MEMBER,ACCOUNTANT,ATTORNEY,OTHER - allows_email
Type: boolean
Whether this person allows email communication
Example Request
curl --request POST \
--url https://api.flextract.dev/api/verify/otp/ \
--header 'accept: application/json' \
--header 'content-type: application/json'
Example Response
{
"token": "abcdef1234567890",
"phone_number": "+111111111",
"status": "verified",
"person": {
"id": "abc123",
"preferred_name": "John Doe",
"email_address": "john@example.com",
"role": "CLIENT",
"allows_email": true
}
}