Skip to main content

Create Individual Party in UDA Connector

This document is the exhaustive current-state mapping reference for entityType = INDIVIDUAL.

Read it together with the common create-party reference, which documents the common flow and common UDA fields shared by all supported create requests.

Request Field Coverage

Status meanings:

  • direct: value is written to UDA
  • selection only: value influences picker behavior but is not forwarded as its own UDA field
  • ignored: value is accepted by the connector request contract but is not used in the current UDA create flow
Request field pathStatusUDA target / effectNotes
entityTypeselection onlySelects individual mapper; results in AmlType = IND and ClientType = IndividualMust be INDIVIDUAL.
nameignoredNoneAccepted through the shared base contract, but not used for individual create.
emailAddresses[].purposeignoredNoneCurrent individual email selection does not look at purpose.
emailAddresses[].isPreferredselection onlyChooses which email address is usedPreferred item wins; otherwise first item is used.
emailAddresses[].addressdirectEmailExactly one selected email address is written.
phoneNumbers[].purposeselection onlyChooses which phone number is usedMOBILE is preferred, but selected purpose is not forwarded directly to UDA.
phoneNumbers[].isPreferredselection onlyChooses which phone number is usedPreferred items win before non-preferred items.
phoneNumbers[].countryCodeignoredNoneCurrent mapper uses fullNumber only.
phoneNumbers[].areaCodeignoredNoneCurrent mapper uses fullNumber only.
phoneNumbers[].numberignoredNoneCurrent mapper uses fullNumber only.
phoneNumbers[].extensionignoredNoneCurrent mapper uses fullNumber only.
phoneNumbers[].fullNumberdirectPhoneNumbers[0].Number+61 is converted to leading 0.
addresses[].purposeselection onlyChooses residential and mailing addressesRESIDENTIAL is preferred for residential; POSTAL is preferred for mailing.
addresses[].isPreferredselection onlyChooses residential and mailing addressesPreferred items can override purpose-specific fallback order.
addresses[].dpidignoredNoneRequired by schema, but not forwarded during current create.
addresses[].addressLinedirectResidentialAddress.Line1/Line2, MailingAddress.Line1/Line2, Verification.Address.Line1/Line2Split at 32 characters.
addresses[].thoroughfareNumber1ignoredNoneNot forwarded during current create.
addresses[].thoroughfareNumber1SuffixignoredNoneNot forwarded during current create.
addresses[].thoroughfareNumber2ignoredNoneNot forwarded during current create.
addresses[].thoroughfareNumber2SuffixignoredNoneNot forwarded during current create.
addresses[].flatUnitTypeignoredNoneNot forwarded during current create.
addresses[].flatUnitNumberignoredNoneNot forwarded during current create.
addresses[].floorLevelTypeignoredNoneNot forwarded during current create.
addresses[].floorLevelNumberignoredNoneNot forwarded during current create.
addresses[].lotNumberignoredNoneNot forwarded during current create.
addresses[].buildingName1ignoredNoneNot forwarded during current create.
addresses[].buildingName2ignoredNoneNot forwarded during current create.
addresses[].streetNameignoredNoneNot forwarded during current create.
addresses[].streetTypeignoredNoneNot forwarded during current create.
addresses[].streetSuffixignoredNoneNot forwarded during current create.
addresses[].postalDeliveryTypeignoredNoneNot forwarded during current create.
addresses[].postalDeliveryNumberignoredNoneNot forwarded during current create.
addresses[].postalDeliveryNumberPrefixignoredNoneNot forwarded during current create.
addresses[].postalDeliveryNumberSuffixignoredNoneNot forwarded during current create.
addresses[].localityNamedirectResidentialAddress.Suburb, MailingAddress.Suburb, Verification.Address.SuburbTaken from the selected addresses.
addresses[].postcodedirectResidentialAddress.Postcode, MailingAddress.Postcode, Verification.Address.PostcodeTaken from the selected addresses.
addresses[].statedirectResidentialAddress.State, MailingAddress.State, Verification.Address.StatePassed through directly.
addresses[].isCurrentignoredNoneNot forwarded during current create.
addresses[].validFromignoredNoneNot forwarded during current create.
addresses[].validToignoredNoneNot forwarded during current create.
entityDetails.firstNamedirectGivenNames, Verification.GivenNameAlso participates in the derived GivenNames value.
entityDetails.middleNamedirectGivenNamesAppended to firstName, then truncated to 36 chars.
entityDetails.lastNamedirectSurname, Verification.SurnameDirect mapping.
entityDetails.dateOfBirthdirectDateOfBirth, Verification.DateOfBirthFormatted to yyyy-MM-dd in UTC.
entityDetails.placeOfBirthignoredNoneAccepted but not forwarded during current create.
entityDetails.nationalityignoredNoneAccepted but not forwarded during current create.
entityDetails.genderignoredNoneCurrent create hardcodes Sex = U instead.
entityDetails.arkVerificationIddirectVerificationDocuments[0].Fields[*]Written as the configured verification reference field.
entityDetails.kyxVerificationDatedirectVerificationDocuments[0].Fields[*]Written as the configured verification date field.

Enum and Selection Behavior

entityType

Request enumCurrent UDA effect
INDIVIDUALAmlType = IND, ClientType = Individual

PhonePurpose

Current individual phone selection order:

  1. preferred MOBILE
  2. any preferred phone
  3. first MOBILE
  4. first phone

Current important limitation:

  • the selected phone purpose is not preserved in the outgoing UDA payload
  • the outgoing UDA phone is always written as Type = M, Location = HOME, IsHomeNumber = true, Category = MobileHome (UDA ContactCategory enum; required — UDA rejects payloads missing Category with "'CATEGORY' field is mandatory")

EmailPurpose

Current individual email selection order:

  1. first preferred email
  2. first email

There is no direct EmailPurpose -> UDA enum/code mapping in current individual create.

AddressPurpose

Current individual residential-address selection order:

  1. preferred RESIDENTIAL
  2. any preferred address
  3. first RESIDENTIAL
  4. first address

Current individual mailing-address selection order:

  1. preferred POSTAL
  2. any preferred address
  3. first POSTAL
  4. first address

There is no direct AddressPurpose -> UDA enum/code mapping in current individual create.

Gender

Request enumCurrent UDA effect
MALEignored on create
FEMALEignored on create
OTHERignored on create
PREFER_NOT_TO_SAYignored on create

Current create always sends Sex = U.

Individual-Specific UDA Fields

These fields are added on top of the common fields documented in the common create-party reference.

UDA fieldCurrent source / valueNotes
AmlTypeHardcoded INDSelected by entityType = INDIVIDUAL.
ClientTypeHardcoded IndividualSelected by entityType = INDIVIDUAL.
DateOfBirthentityDetails.dateOfBirthFormatted to yyyy-MM-dd UTC.
EmployeeNumberEmpty stringHardcoded.
GivenNamesfirstName + middleNameTrimmed and truncated to 36 chars.
MaritalStatusEmpty stringHardcoded.
MemberType99Hardcoded current value.
PhoneNumbersSelected request phoneEmitted as Type=M, Location=HOME, IsHomeNumber=true.
SexHardcoded UCurrent create does not map request gender.
SurnameentityDetails.lastNameDirect mapping.
Verification.AddressSelected residential addressSame mapped value as the chosen residential address.
Verification.AddressDocumentIdcreatePartyConfig.idReferenceDocumentIdConfiguration-driven.
Verification.DateOfBirthentityDetails.dateOfBirthSame formatted value as top-level DateOfBirth.
Verification.DateOfBirthDocumentIdcreatePartyConfig.idReferenceDocumentIdConfiguration-driven.
Verification.GivenNameentityDetails.firstNameFirst name only.
Verification.NameDocumentIdcreatePartyConfig.idReferenceDocumentIdConfiguration-driven.
Verification.SurnameentityDetails.lastNameDirect mapping.
VerificationDocuments.VerificationDocument[0].DocumentcreatePartyConfig.idReferenceDocumentIdConfiguration-driven document ID.
VerificationDocuments.VerificationDocument[0].Fields[*].FieldIdcreatePartyConfig.idReferenceDocumentDateId, createPartyConfig.idReferenceDocumentReferenceIdConfiguration-driven field IDs.
VerificationDocuments.VerificationDocument[0].Fields[*].FieldValuekyxVerificationDate, arkVerificationIdDate is formatted as dd MMM yyyy UTC and uppercased.
VerificationProfiles.ClientVerificationProfileHardcoded current profile setSee IDs below.

Current individual verification profile IDs:

  • 47 = Australia
  • 180 = 0
  • 182 = 0
  • 184 = 0
  • 185 = 0

Fields Accepted But Not Currently Forwarded To UDA

The following request data is currently accepted by the connector create request contract but never written into any UDA create payload:

  • top-level name
  • emailAddresses[].purpose
  • phoneNumbers[].countryCode
  • phoneNumbers[].areaCode
  • phoneNumbers[].number
  • phoneNumbers[].extension
  • addresses[].dpid
  • all address structure fields except addressLine, localityName, postcode, and state
  • addresses[].isCurrent
  • addresses[].validFrom
  • addresses[].validTo
  • entityDetails.placeOfBirth
  • entityDetails.nationality
  • entityDetails.gender