My Details

This set of screens are where a user may update their profile, report an issue and read legal information.

User information

API

The api below describes how the information for the above screenshot is retrieved.

Name - “John Smith”

The users name is available from the user profile endpoint.

• key: preferred_name

Response

• Type: 200 OK

{
  "url": "https://st.igate-test.co.uk/api/v1/user/profile/cb7d3f93-ccce-48d4-bf82-4c3dcb54d6ee/",
  "uuid": "cb7d3f93-ccce-48d4-bf82-4c3dcb54d6ee",
  "created_at": "2024-11-29T09:49:24.049001Z",
  "updated_at": "2024-11-29T09:49:24.049093Z",
  "first_name": "John",
  "last_name": "Smith",
  "preferred_name": "John Smith",
  "phone_number": null,
  "gender_id": null,
  "gender_name": null,
  "marital_status_id": null,
  "marital_status_name": null,
  "date_of_birth": null,
  "driving_licence_number": null,
  "licence_type_id": null,
  "licence_type_name": null,
  "date_licence_obtained": null,
  "home_owner": null,
  "uk_resident_since_birth": null,
  "uk_resident_years": null,
  "receive_notifications": null,
  "email_subscriptions": null,
  "sms_alerts": null
}

Email - “johnsmith@gmail.com”

A users email address can be found on their user object.

• key: email

To retrieve the user email address use the user endpoint.

Response

• Type: 200 OK

{
  "url": "https://st.igate-test.co.uk/api/v1/users/c0eb56f0-453a-4520-b392-75f38c6fe1d9/",
  "uuid": "c0eb56f0-453a-4520-b392-75f38c6fe1d9",
  "username": "johnsmith@gmail.com",
  "email": "johnsmith@gmail.com",
  "accepts_terms": true,
  "accepts_marketing": true,
  "profile": "https://st.igate-test.co.uk/api/v1/user/profile/cb7d3f93-ccce-48d4-bf82-4c3dcb54d6ef/",
  "address": "https://st.igate-test.co.uk/api/v1/user/address/898c6364-eaff-49bc-8ce6-7256029a81d2/",
  "vehicles": [],
  "occupations": []
}