Skip to content

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
}
FieldTypeDescription
euaRequiredbooleanWhether the user still needs to respond
currentVersionstringAgreement version in force
statusstring or nullACCEPTED, DECLINED, or null when there is no response yet
acceptedVersionstring or nullVersion the user accepted
acceptedAtstring or nullWhen the user accepted
declinedAtstring or nullWhen the user declined

Record a response ​

FieldTypeRequiredDescription
actionstringyesACCEPTED or DECLINED
agreementVersionstringyesMust match the current agreement version. 1–32 characters
sourcestringnoWEB 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 ​

StatusCodeWhen
400VALIDATION_ERRORaction or agreementVersion is missing, or the version does not match
401The bearer token is missing or invalid
500INTERNAL_ERRORSomething unexpected failed