Documentation
Verification (v1)
Auth
verify user
POST /verify/auth
POST verfification data to authenticate and login user
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| telephone | users telephone number |
YES | |
| code | string | the verification code |
YES |
| agb | boolean | users agb confirmation |
NO |
| dataprotection | boolean | users data protection confirmation |
NO |
| pushToken | string | push token for sending push notifications |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.verification.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.verification.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"telephone": "users telephone number",
"code": "the verification code",
"agb": "users agb confirmation",
"dataprotection": "users data protection confirmation",
"pushToken": "push token for sending push notifications"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.verification.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Code
verify user
POST /verify/code
POST users telephone number and verification code to check if the entered verification code is correct
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| telephone | string | users telephone number |
YES |
| code | string | the verification code |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.verification.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.verification.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"telephone": "users telephone number",
"code": "the verification code"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.verification.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Sms
verify user
POST /verify/sms
POST the users telephone number to get a verification code
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| telephone | string | the users telephone number |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.verification.v1+json
application/json
application/*+json |
| Content-Type | application/vnd.verification.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
{
"telephone": "the users telephone number"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.verification.v1+json
application/json
application/*+json |
| Allow | Comma-separated list of all HTTP methods allowed |