---
title: "Put End User Data"
method: POST
path: "/journey/task/update"
tags: ["End User APIs", "Task Service"]
---

# Put End User Data

`POST /journey/task/update`

Put End User Data

## Request body

- object
  - `instanceId` string, required — Journey Instance Id, a unique identifier for a started journey instance.
  - `taskId` string, required — Task Id, a unique identifier for a task assigned to an End User during a Journey.
  - `intent` 'Save' | 'Complete' | 'Validate', required
  - `context` object
    - `subject` object, required
      - `identity` object
        - `title` string — Title of an individual such as Mr, Mrs, Dr, Sir
        - `firstName` string — A person's name used by their collegues and friends to address them
        - `middleNames` string[] — Any other registered names used by the individual, not aliases
        - `lastNames` string[] — Any family names for the individual
        - `lastNamesAtBirth` string[] — Any family names for the individual
        - `aliases` object[]
          - `title` string — Title of an individual such as Mr, Mrs, Dr, Sir
          - `firstName` string — A person's name used by their collegues and friends to address them
          - `middleNames` string[] — Any other registered names used by the individual, not aliases
          - `lastNames` string[] — Any family names for the individual
          - `lastNamesAtBirth` string[] — Any family names for the individual
        - `relatedPersons` object[]
          - `title` string — Title of an individual such as Mr, Mrs, Dr, Sir
          - `firstName` string — A person's name used by their collegues and friends to address them
          - `middleNames` string[] — Any other registered names used by the individual, not aliases
          - `lastNames` string[] — Any family names for the individual
          - `lastNamesAtBirth` string[] — Any family names for the individual
          - `relationship` 'mother' | 'father' | 'maternalGrandFather' | 'maternalGrandMother' | 'paternalGrandFather' | 'paternalGrandMother', required
        - `dateOfBirth` string — Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
        - `gender` string
        - `currentAddress` object
          - `lines` string[] — Unformatted line based address
          - `addressString` string — The address as a single line
          - `premise` string — The primary delivery point for a premise or building. This could be a house number, a building name, etc.
          - `building` string — The name of a building or a building complex. In the US, this is the street number.
          - `subBuilding` string — The name of a sub-building, such as a flat or apartment number.
          - `thoroughfare` string — This field holds the most common street or block data element within a country. For instance, USA Street
          - `dependentThoroughfare` string — The name of a dependent street or block, such as a street within a complex.
          - `locality` string — This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
          - `dependentLocality` string — This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
          - `doubleDependentLocality` string — This is an even smaller area within a dependent locality, often used in very detailed addresses.
          - `postalCode` string — This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
          - `postBox` string — This field contains the post box number associated with a particular delivery point, should one exist.
          - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
          - `superAdministrativeArea` string
          - `administrativeArea` string
          - `subAdministrativeArea` string
          - `organization` string
          - `location` object
            - `latitude` string
            - `longitude` string
            - `geoAccuracy` string
            - `what3words` string — A What3words designation associated with this location with '.' separator.
        - `previousAddresses` object[]
          - `lines` string[] — Unformatted line based address
          - `addressString` string — The address as a single line
          - `premise` string — The primary delivery point for a premise or building. This could be a house number, a building name, etc.
          - `building` string — The name of a building or a building complex. In the US, this is the street number.
          - `subBuilding` string — The name of a sub-building, such as a flat or apartment number.
          - `thoroughfare` string — This field holds the most common street or block data element within a country. For instance, USA Street
          - `dependentThoroughfare` string — The name of a dependent street or block, such as a street within a complex.
          - `locality` string — This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
          - `dependentLocality` string — This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
          - `doubleDependentLocality` string — This is an even smaller area within a dependent locality, often used in very detailed addresses.
          - `postalCode` string — This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
          - `postBox` string — This field contains the post box number associated with a particular delivery point, should one exist.
          - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
          - `superAdministrativeArea` string
          - `administrativeArea` string
          - `subAdministrativeArea` string
          - `organization` string
          - `location` object
            - `latitude` string
            - `longitude` string
            - `geoAccuracy` string
            - `what3words` string — A What3words designation associated with this location with '.' separator.
          - `fromDate` string, required — Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
          - `toDate` string, required — Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
        - `placeOfBirth` object
          - `lines` string[] — Unformatted line based address
          - `addressString` string — The address as a single line
          - `premise` string — The primary delivery point for a premise or building. This could be a house number, a building name, etc.
          - `building` string — The name of a building or a building complex. In the US, this is the street number.
          - `subBuilding` string — The name of a sub-building, such as a flat or apartment number.
          - `thoroughfare` string — This field holds the most common street or block data element within a country. For instance, USA Street
          - `dependentThoroughfare` string — The name of a dependent street or block, such as a street within a complex.
          - `locality` string — This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
          - `dependentLocality` string — This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
          - `doubleDependentLocality` string — This is an even smaller area within a dependent locality, often used in very detailed addresses.
          - `postalCode` string — This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
          - `postBox` string — This field contains the post box number associated with a particular delivery point, should one exist.
          - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
          - `superAdministrativeArea` string
          - `administrativeArea` string
          - `subAdministrativeArea` string
          - `organization` string
          - `location` object
            - `latitude` string
            - `longitude` string
            - `geoAccuracy` string
            - `what3words` string — A What3words designation associated with this location with '.' separator.
        - `idNumbers` object[]
          - `type` string, required — The type of phone number, such as landline, mobile, fax, unknown etc
          - `idNumber` string, required — ID number eg, National Insurance Number in UK, Social Securtiy Number in US
          - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
        - `phones` object[]
          - `type` string, required — The type of phone number, such as landline, mobile, fax, unknown etc
          - `number` string, required — Phone number, ideally in international format with +(Country Code)
        - `emails` object[]
          - `type` string, required — The type of email, such as home, work, unknown etc
          - `email` string, required — Email address
        - `socials` object[]
          - `type` string, required — An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc
          - `identity` string, required — the identity used on this platform
        - `mothersMaidenName` string — The subject's mother's maiden name, used for identity verification
      - `documents` object[]
        - `oneDBarcode` string
        - `address` object
          - `addressString` string
          - `extractedAddressString` string
          - `addressLine1` string
          - `addressLine2` string
          - `locality` string
          - `administrativeArea` string
          - `postalCode` string
        - `applicationDate` string
        - `applicationNumber` string
        - `dateOfBirth` string
        - `placeOfBirth` string
        - `placeOfBirthNative` string
        - `bloodType` string
        - `controlNumber` string
        - `countryCode` string
        - `countryName` string
        - `documentClassCode` string
        - `documentClassName` string
        - `documentNumber` string
        - `documentSignerCertificate` string
        - `employer` string
        - `employerAddress` string
        - `entries` string
        - `expirationDate` string
        - `eyeColor` string
        - `fathersName` string
        - `fathersNameNative` string
        - `fathersSurname` string
        - `firstName` string
        - `fullName` string
        - `fullNameNative` string
        - `givenName` string
        - `givenNameNative` string
        - `hairColor` string
        - `height` string
        - `issueDate` string — Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
        - `issuingAuthority` string
        - `issuingAuthorityNative` string
        - `issuingStateCode` string
        - `issuingStateName` string
        - `licenseClass` string
        - `licenseEndorsements` string
        - `licenseRestrictions` string
        - `mrz` string
        - `mrz1` string
        - `mrz2` string
        - `mrz3` string
        - `middleName` string
        - `mothersName` string
        - `mothersNameNative` string
        - `mothersSurname` string
        - `nameSuffix` string
        - `nationalityCode` string
        - `nationalityName` string
        - `nationalityNameNative` string
        - `occupation` string
        - `organDonor` boolean
        - `passportNumber` string
        - `permitNumber` string
        - `personalNumber` string
        - `photo` string
        - `photoCompressed` string
        - `photoEncoding` string
        - `sex` string
        - `sexNative` string
        - `signature` string
        - `signatureCompressed` string
        - `signatureEncoding` string
        - `socialSecurityNumber` string
        - `startDate` string
        - `surname` string
        - `surnameNative` string
        - `visaClass` string
        - `visaNumber` string
        - `weight` string
        - `cardNumber` string
        - `issuerCountryCode` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
        - `id` string
        - `type` string
        - `category` string
        - `subtype` string
        - `format` string
        - `device` object
          - `type` string
          - `model` string
          - `hasContactlessReader` boolean
          - `hasMagneticStripeReader` boolean
          - `hasCamera` boolean
          - `serialNumber` string
          - `manufacturer` string
        - `side1Image` string
        - `side2Image` string
        - `chip` object
          - `lds` object[], required
            - `name` 'COM' | 'SOD' | 'DG1' | 'DG2' | 'DG3' | 'DG4' | 'DG5' | 'DG6' | 'DG7' | 'DG8' | 'DG9' | 'DG10' | 'DG11' | 'DG12' | 'DG13' | 'DG14' | 'DG15', required
            - `data` string, required
          - `auth` object[], required
            - `type` 'ActiveAuthentication' | 'BasicAccessControl' | 'ChipAuthentication' | 'PassiveAuthentication' | 'SupplementalAccessControl' | 'ExtendedAccessControl' | 'TerminalAuthentication', required
            - `result` 'Success' | 'Failure' | 'Skipped', required
        - `classification` object
          - `ids` string[]
          - `category` string
          - `type` string
          - `subtype` string
          - `isDoubleSided` boolean
          - `hasNFC` boolean
          - `year` string
          - `countryCode` string
          - `countryName` string
          - `stateCode` string
          - `stateName` string
          - `sides` object[]
            - `side` string, required
            - `id` string, required
            - `documentQuality` string, required
            - `documentQualityScore` number, required
        - `extraction` object
          - `aggregatedFields` object[]
            - `label` string, required
            - `value` string, required
            - `source` string, required
            - `isNonLatin` boolean, required
            - `regionOfInterest` object
              - …
          - `extractedFields` object[]
            - `label` string, required
            - `details` object[], required
              - …
          - `extractedImages` object[]
            - `label` string, required
            - `side` string, required
            - `imageID` string, required
        - `validation` object
          - `validationChecks` object[]
            - `name` string, required
            - `title` string, required
            - `info` string, required
            - `validationResult` string, required
            - `resultInfo` string, required
            - `weight` string, required
            - `regionOfInterests` object[]
              - …
            - `type` string, required
          - `aggregatedValidationChecks` object[]
            - `name` string, required
            - `title` string, required
            - `info` string, required
            - `validationResult` string, required
            - `resultInfo` string, required
            - `weight` string, required
            - `regionOfInterests` object[]
              - …
            - `type` string, required
        - `subType` string
        - `number` string
        - `expiryDate` string — Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
        - `subject` object
          - `title` string — Title of an individual such as Mr, Mrs, Dr, Sir
          - `firstName` string — A person's name used by their collegues and friends to address them
          - `middleNames` string[] — Any other registered names used by the individual, not aliases
          - `lastNames` string[] — Any family names for the individual
          - `lastNamesAtBirth` string[] — Any family names for the individual
          - `aliases` object[]
            - `title` string — Title of an individual such as Mr, Mrs, Dr, Sir
            - `firstName` string — A person's name used by their collegues and friends to address them
            - `middleNames` string[] — Any other registered names used by the individual, not aliases
            - `lastNames` string[] — Any family names for the individual
            - `lastNamesAtBirth` string[] — Any family names for the individual
          - `relatedPersons` object[]
            - `title` string — Title of an individual such as Mr, Mrs, Dr, Sir
            - `firstName` string — A person's name used by their collegues and friends to address them
            - `middleNames` string[] — Any other registered names used by the individual, not aliases
            - `lastNames` string[] — Any family names for the individual
            - `lastNamesAtBirth` string[] — Any family names for the individual
            - `relationship` 'mother' | 'father' | 'maternalGrandFather' | 'maternalGrandMother' | 'paternalGrandFather' | 'paternalGrandMother', required
          - `dateOfBirth` string — Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
          - `gender` string
          - `currentAddress` object
            - `lines` string[] — Unformatted line based address
            - `addressString` string — The address as a single line
            - `premise` string — The primary delivery point for a premise or building. This could be a house number, a building name, etc.
            - `building` string — The name of a building or a building complex. In the US, this is the street number.
            - `subBuilding` string — The name of a sub-building, such as a flat or apartment number.
            - `thoroughfare` string — This field holds the most common street or block data element within a country. For instance, USA Street
            - `dependentThoroughfare` string — The name of a dependent street or block, such as a street within a complex.
            - `locality` string — This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
            - `dependentLocality` string — This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
            - `doubleDependentLocality` string — This is an even smaller area within a dependent locality, often used in very detailed addresses.
            - `postalCode` string — This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
            - `postBox` string — This field contains the post box number associated with a particular delivery point, should one exist.
            - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
            - `superAdministrativeArea` string
            - `administrativeArea` string
            - `subAdministrativeArea` string
            - `organization` string
            - `location` object
              - …
          - `previousAddresses` object[]
            - `lines` string[] — Unformatted line based address
            - `addressString` string — The address as a single line
            - `premise` string — The primary delivery point for a premise or building. This could be a house number, a building name, etc.
            - `building` string — The name of a building or a building complex. In the US, this is the street number.
            - `subBuilding` string — The name of a sub-building, such as a flat or apartment number.
            - `thoroughfare` string — This field holds the most common street or block data element within a country. For instance, USA Street
            - `dependentThoroughfare` string — The name of a dependent street or block, such as a street within a complex.
            - `locality` string — This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
            - `dependentLocality` string — This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
            - `doubleDependentLocality` string — This is an even smaller area within a dependent locality, often used in very detailed addresses.
            - `postalCode` string — This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
            - `postBox` string — This field contains the post box number associated with a particular delivery point, should one exist.
            - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
            - `superAdministrativeArea` string
            - `administrativeArea` string
            - `subAdministrativeArea` string
            - `organization` string
            - `location` object
              - …
            - `fromDate` string, required — Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
            - `toDate` string, required — Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
          - `placeOfBirth` object
            - `lines` string[] — Unformatted line based address
            - `addressString` string — The address as a single line
            - `premise` string — The primary delivery point for a premise or building. This could be a house number, a building name, etc.
            - `building` string — The name of a building or a building complex. In the US, this is the street number.
            - `subBuilding` string — The name of a sub-building, such as a flat or apartment number.
            - `thoroughfare` string — This field holds the most common street or block data element within a country. For instance, USA Street
            - `dependentThoroughfare` string — The name of a dependent street or block, such as a street within a complex.
            - `locality` string — This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
            - `dependentLocality` string — This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
            - `doubleDependentLocality` string — This is an even smaller area within a dependent locality, often used in very detailed addresses.
            - `postalCode` string — This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
            - `postBox` string — This field contains the post box number associated with a particular delivery point, should one exist.
            - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
            - `superAdministrativeArea` string
            - `administrativeArea` string
            - `subAdministrativeArea` string
            - `organization` string
            - `location` object
              - …
          - `idNumbers` object[]
            - `type` string, required — The type of phone number, such as landline, mobile, fax, unknown etc
            - `idNumber` string, required — ID number eg, National Insurance Number in UK, Social Securtiy Number in US
            - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
          - `phones` object[]
            - `type` string, required — The type of phone number, such as landline, mobile, fax, unknown etc
            - `number` string, required — Phone number, ideally in international format with +(Country Code)
          - `emails` object[]
            - `type` string, required — The type of email, such as home, work, unknown etc
            - `email` string, required — Email address
          - `socials` object[]
            - `type` string, required — An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc
            - `identity` string, required — the identity used on this platform
          - `mothersMaidenName` string — The subject's mother's maiden name, used for identity verification
        - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
      - `biometrics` union[]
        - union
          - object
            - `id` string
            - `type` string
            - `face1Image` string, required
            - `face2Image` string, required
          - object
            - `id` string
            - `type` string
            - `selfieImage` string, required
            - `anchorImage` string, required
          - object
            - `id` string
            - `type` string
            - `faceImage` string, required
          - object
            - `id` string
            - `type` string
            - `selfieImage` string, required
            - `selfieImageEncryption` boolean
      - `sessions` object[]
        - `user` object
          - `id` string, required
          - `email` string, email, required
          - `domain` string, required
        - `client` object
          - `id` string, required
          - `ip` string, required
          - `address` string, required
        - `device` object
          - `id` string, required
          - `manufacturer` string, required
          - `model` object, required
            - `identifier` string, required
            - `name` string, required
        - `trace` object
          - `id` string, required
        - `span` object
          - `id` string, required
        - `transaction` object
          - `id` string, required
        - `auth` object[]
          - `id` string, required
          - `scope` string
          - `codeVerifier` string
          - `code` string
          - `state` string
          - `redirectUri` string
          - `responseType` string
          - `clientId` string
          - `clientSecret` string
      - `consent` object[]
        - `type` 'rollup' | 'explicit' | 'implicit'
        - `id` string
        - `version` string
        - `url` string, uri, required
        - `effectiveDate` string
        - `expiryDate` string
        - `terms` string
        - `purpose` string
        - `legalBasis` string
        - `jurisdiction` string
        - `subject` string
        - `signatory` string
      - `accounts` object[]
        - `type` string, required — The type of account, e.g. Bank Account, Building Society
        - `accountNumber` string, required — Account number
        - `sortCode` string — UK sort code
        - `routingNumber` string — US ABA routing number
        - `iban` string — International Bank Account Number
        - `bic` string — BIC/SWIFT code
        - `accountHolderName` string — Name on the account
        - `bankName` string — Name of the financial institution
        - `country` string — Country the address is in. It must be a valid ISO2 or ISO3 country code
        - `accountType` string — Account classification, e.g. current, savings
      - `uid` string
  - `data` object

## Response `200`

Success

- object
  - `instanceId` string, required — Journey Instance Id, a unique identifier for a started journey instance.
  - `taskId` string, required — Task Id, a unique identifier for a task assigned to an End User during a Journey.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `405` — Method Not Allowed
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/gbgplc/apis/gbg-go-next-gen-flow-captain-api.md) · [All operations](https://skmtc.net/gbgplc/apis/gbg-go-next-gen-flow-captain-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gbgplc/gbg-go-next-gen-flow-captain-api/revisions/38056a3470d6/schema)