Appearance
User agreement
Reads or records whether the signed-in user accepted the current end-user agreement.
The user is taken from the bearer token. Do not send an email in the body.
GET /fieldservicegateway/usermanagement/v3/user-agreement
POST /fieldservicegateway/usermanagement/v3/user-agreement
Get status
GET has no body.
cURL
bash
curl --request GET 'https://[BASE_URL]/fieldservicegateway/usermanagement/v3/user-agreement' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Asurion-correlationid: correlation-id' \
--header 'Asurion-enduser: end-user' \
--header 'Asurion-sourcesystem: source-system' \
--header 'Asurion-serviceprovider: company-id' \
--header 'Asurion-client: default'Response
200 OK
json
{
"euaRequired": true,
"currentVersion": "1.0",
"status": null,
"acceptedVersion": null,
"acceptedAt": null,
"declinedAt": null
}| Field | Type | Description |
|---|---|---|
euaRequired | boolean | Whether the user still needs to respond |
currentVersion | string | Agreement version in force |
status | string or null | ACCEPTED, DECLINED, or null when there is no response yet |
acceptedVersion | string or null | Version the user accepted |
acceptedAt | string or null | When the user accepted |
declinedAt | string or null | When the user declined |
Record a response
| Field | Type | Required | Description |
|---|---|---|---|
action | string | yes | ACCEPTED or DECLINED |
agreementVersion | string | yes | Must match the current agreement version. 1–32 characters |
source | string | no | WEB or MOBILE. Defaults to WEB |
Example
json
{
"action": "ACCEPTED",
"agreementVersion": "1.0",
"source": "WEB"
}cURL
bash
curl --request POST 'https://[BASE_URL]/fieldservicegateway/usermanagement/v3/user-agreement' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {{x-api-key}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Asurion-correlationid: correlation-id' \
--header 'Asurion-enduser: end-user' \
--header 'Asurion-sourcesystem: source-system' \
--header 'Asurion-serviceprovider: company-id' \
--header 'Asurion-client: default' \
--data '{
"action": "ACCEPTED",
"agreementVersion": "1.0",
"source": "WEB"
}'Response
200 OK
json
{
"status": "ACCEPTED",
"euaRequired": false,
"currentVersion": "1.0",
"acceptedVersion": "1.0",
"acceptedAt": "2026-10-16T00:00:00.000Z",
"declinedAt": null
}Errors
| Status | Code | When |
|---|---|---|
| 400 | VALIDATION_ERROR | action or agreementVersion is missing, or the version does not match |
| 401 | The bearer token is missing or invalid | |
| 500 | INTERNAL_ERROR | Something unexpected failed |