v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Account

Account:Me

Patch account information linked to the provided JWT token

patch/v2/accounts/me

Request body

otpstring required
emailstring email required
passwordstring nullable
genderstring nullable
firstNamestring nullable
lastNamestring nullable
locale'nl_NL' | 'en_GB' | 'it_IT' | 'es_ES' | 'nl_BE' | 'de_DE' | 'fr_FR' required
nationalitystring nullable
dateOfBirthstring nullable
phoneNumberstring nullable
newsletterboolean required

Response

OK

codestring
emailstring
gender'm' | 'f' | 'null' nullable
firstNamestring nullable
lastNamestring nullable
localestring nullable
languagestring nullable
nationalitystring nullable
dateOfBirthstring nullable
phoneNumberstring nullable
phonestring nullable
avatarstring nullable
newsletterboolean

Example response

{
  "code": "A-1234-4321",
  "email": "account@gmail.com",
  "firstName": "Robbert",
  "lastName": "van der Werf",
  "locale": "nl_NL",
  "language": "nl_NL",
  "nationality": "NL",
  "dateOfBirth": "1940-10-03",
  "phoneNumber": "+31612345678",
  "phone": "+31612345678",
  "avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA",
  "activeMerchant": {
    "code": "M-1234-4321",
    "name": "GMS Demo Merchant",
    "icon": "https://rest-api.pay.nl/v2/icons/M-1234-4321",
    "status": "ACTIVE"
  },
  "2fa": {
    "method": "otp"
  },
  "visitAddress": {
    "code": "CA-1234-4312",
    "streetName": "Delivery-Lane",
    "streetNumber": "70",
    "zipCode": "1234CD",
    "city": "Amsterdam",
    "countryCode": "NL"
  },
  "loginAttempts": [
    {
      "code": "LA-1234-4321-1234",
      "attemptedAt": "2024-06-04T08:15:00+01:00",
      "status": "SUCCESS",
      "ipAddress": "123.12.13.8",
      "browser": "Microsoft Edge 97.0.1072.55",
      "platform": "Windows 11"
    }
  ],
  "devices": [
    {
      "code": "AD-1234-4321",
      "name": "iPhone 14",
      "lastUsedAt": "2024-06-04T08:15:00+01:00"
    }
  ],
  "documents": [
    {
      "code": "D-3713-6776",
      "type": "identification",
      "status": "APPROVED",
      "name": "Copy ID or passport",
      "description": "Identification document is required for verification purposes",
      "translations": {
        "...": {
          "nl_NL": "The Dutch translation",
          "en_GB": "The British translation",
          "nl_BE": "The Flemish translation",
          "fr_FR": "The French translation",
          "de_DE": "The German translation",
          "it_IT": "The Italian translation",
          "es_ES": "The Spanish translation"
        }
      },
      "acceptedAt": "2024-06-04T08:15:00+01:00",
      "createdAt": "2024-06-04T08:15:00+01:00",
      "createdBy": "A-1234-4321",
      "modifiedAt": "2024-06-04T08:15:00+01:00",
      "modifiedBy": "A-1234-4321",
      "deletedAt": "A-1234-4321",
      "deletedBy": "A-1234-4321"
    }
  ]
}