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 UDAselection only: value influences picker behavior but is not forwarded as its own UDA fieldignored: value is accepted by the connector request contract but is not used in the current UDA create flow
| Request field path | Status | UDA target / effect | Notes |
|---|---|---|---|
entityType | selection only | Selects individual mapper; results in AmlType = IND and ClientType = Individual | Must be INDIVIDUAL. |
name | ignored | None | Accepted through the shared base contract, but not used for individual create. |
emailAddresses[].purpose | ignored | None | Current individual email selection does not look at purpose. |
emailAddresses[].isPreferred | selection only | Chooses which email address is used | Preferred item wins; otherwise first item is used. |
emailAddresses[].address | direct | Email | Exactly one selected email address is written. |
phoneNumbers[].purpose | selection only | Chooses which phone number is used | MOBILE is preferred, but selected purpose is not forwarded directly to UDA. |
phoneNumbers[].isPreferred | selection only | Chooses which phone number is used | Preferred items win before non-preferred items. |
phoneNumbers[].countryCode | ignored | None | Current mapper uses fullNumber only. |
phoneNumbers[].areaCode | ignored | None | Current mapper uses fullNumber only. |
phoneNumbers[].number | ignored | None | Current mapper uses fullNumber only. |
phoneNumbers[].extension | ignored | None | Current mapper uses fullNumber only. |
phoneNumbers[].fullNumber | direct | PhoneNumbers[0].Number | +61 is converted to leading 0. |
addresses[].purpose | selection only | Chooses residential and mailing addresses | RESIDENTIAL is preferred for residential; POSTAL is preferred for mailing. |
addresses[].isPreferred | selection only | Chooses residential and mailing addresses | Preferred items can override purpose-specific fallback order. |
addresses[].dpid | ignored | None | Required by schema, but not forwarded during current create. |
addresses[].addressLine | direct | ResidentialAddress.Line1/Line2, MailingAddress.Line1/Line2, Verification.Address.Line1/Line2 | Split at 32 characters. |
addresses[].thoroughfareNumber1 | ignored | None | Not forwarded during current create. |
addresses[].thoroughfareNumber1Suffix | ignored | None | Not forwarded during current create. |
addresses[].thoroughfareNumber2 | ignored | None | Not forwarded during current create. |
addresses[].thoroughfareNumber2Suffix | ignored | None | Not forwarded during current create. |
addresses[].flatUnitType | ignored | None | Not forwarded during current create. |
addresses[].flatUnitNumber | ignored | None | Not forwarded during current create. |
addresses[].floorLevelType | ignored | None | Not forwarded during current create. |
addresses[].floorLevelNumber | ignored | None | Not forwarded during current create. |
addresses[].lotNumber | ignored | None | Not forwarded during current create. |
addresses[].buildingName1 | ignored | None | Not forwarded during current create. |
addresses[].buildingName2 | ignored | None | Not forwarded during current create. |
addresses[].streetName | ignored | None | Not forwarded during current create. |
addresses[].streetType | ignored | None | Not forwarded during current create. |
addresses[].streetSuffix | ignored | None | Not forwarded during current create. |
addresses[].postalDeliveryType | ignored | None | Not forwarded during current create. |
addresses[].postalDeliveryNumber | ignored | None | Not forwarded during current create. |
addresses[].postalDeliveryNumberPrefix | ignored | None | Not forwarded during current create. |
addresses[].postalDeliveryNumberSuffix | ignored | None | Not forwarded during current create. |
addresses[].localityName | direct | ResidentialAddress.Suburb, MailingAddress.Suburb, Verification.Address.Suburb | Taken from the selected addresses. |
addresses[].postcode | direct | ResidentialAddress.Postcode, MailingAddress.Postcode, Verification.Address.Postcode | Taken from the selected addresses. |
addresses[].state | direct | ResidentialAddress.State, MailingAddress.State, Verification.Address.State | Passed through directly. |
addresses[].isCurrent | ignored | None | Not forwarded during current create. |
addresses[].validFrom | ignored | None | Not forwarded during current create. |
addresses[].validTo | ignored | None | Not forwarded during current create. |
entityDetails.firstName | direct | GivenNames, Verification.GivenName | Also participates in the derived GivenNames value. |
entityDetails.middleName | direct | GivenNames | Appended to firstName, then truncated to 36 chars. |
entityDetails.lastName | direct | Surname, Verification.Surname | Direct mapping. |
entityDetails.dateOfBirth | direct | DateOfBirth, Verification.DateOfBirth | Formatted to yyyy-MM-dd in UTC. |
entityDetails.placeOfBirth | ignored | None | Accepted but not forwarded during current create. |
entityDetails.nationality | ignored | None | Accepted but not forwarded during current create. |
entityDetails.gender | ignored | None | Current create hardcodes Sex = U instead. |
entityDetails.arkVerificationId | direct | VerificationDocuments[0].Fields[*] | Written as the configured verification reference field. |
entityDetails.kyxVerificationDate | direct | VerificationDocuments[0].Fields[*] | Written as the configured verification date field. |
Enum and Selection Behavior
entityType
| Request enum | Current UDA effect |
|---|---|
INDIVIDUAL | AmlType = IND, ClientType = Individual |
PhonePurpose
Current individual phone selection order:
- preferred
MOBILE - any preferred phone
- first
MOBILE - 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(UDAContactCategoryenum; required — UDA rejects payloads missingCategorywith"'CATEGORY' field is mandatory")
EmailPurpose
Current individual email selection order:
- first preferred email
- first email
There is no direct EmailPurpose -> UDA enum/code mapping in current individual create.
AddressPurpose
Current individual residential-address selection order:
- preferred
RESIDENTIAL - any preferred address
- first
RESIDENTIAL - first address
Current individual mailing-address selection order:
- preferred
POSTAL - any preferred address
- first
POSTAL - first address
There is no direct AddressPurpose -> UDA enum/code mapping in current individual create.
Gender
| Request enum | Current UDA effect |
|---|---|
MALE | ignored on create |
FEMALE | ignored on create |
OTHER | ignored on create |
PREFER_NOT_TO_SAY | ignored 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 field | Current source / value | Notes |
|---|---|---|
AmlType | Hardcoded IND | Selected by entityType = INDIVIDUAL. |
ClientType | Hardcoded Individual | Selected by entityType = INDIVIDUAL. |
DateOfBirth | entityDetails.dateOfBirth | Formatted to yyyy-MM-dd UTC. |
EmployeeNumber | Empty string | Hardcoded. |
GivenNames | firstName + middleName | Trimmed and truncated to 36 chars. |
MaritalStatus | Empty string | Hardcoded. |
MemberType | 99 | Hardcoded current value. |
PhoneNumbers | Selected request phone | Emitted as Type=M, Location=HOME, IsHomeNumber=true. |
Sex | Hardcoded U | Current create does not map request gender. |
Surname | entityDetails.lastName | Direct mapping. |
Verification.Address | Selected residential address | Same mapped value as the chosen residential address. |
Verification.AddressDocumentId | createPartyConfig.idReferenceDocumentId | Configuration-driven. |
Verification.DateOfBirth | entityDetails.dateOfBirth | Same formatted value as top-level DateOfBirth. |
Verification.DateOfBirthDocumentId | createPartyConfig.idReferenceDocumentId | Configuration-driven. |
Verification.GivenName | entityDetails.firstName | First name only. |
Verification.NameDocumentId | createPartyConfig.idReferenceDocumentId | Configuration-driven. |
Verification.Surname | entityDetails.lastName | Direct mapping. |
VerificationDocuments.VerificationDocument[0].Document | createPartyConfig.idReferenceDocumentId | Configuration-driven document ID. |
VerificationDocuments.VerificationDocument[0].Fields[*].FieldId | createPartyConfig.idReferenceDocumentDateId, createPartyConfig.idReferenceDocumentReferenceId | Configuration-driven field IDs. |
VerificationDocuments.VerificationDocument[0].Fields[*].FieldValue | kyxVerificationDate, arkVerificationId | Date is formatted as dd MMM yyyy UTC and uppercased. |
VerificationProfiles.ClientVerificationProfile | Hardcoded current profile set | See IDs below. |
Current individual verification profile IDs:
47 = Australia180 = 0182 = 0184 = 0185 = 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[].purposephoneNumbers[].countryCodephoneNumbers[].areaCodephoneNumbers[].numberphoneNumbers[].extensionaddresses[].dpid- all address structure fields except
addressLine,localityName,postcode, andstate addresses[].isCurrentaddresses[].validFromaddresses[].validToentityDetails.placeOfBirthentityDetails.nationalityentityDetails.gender