DNA-style Fields

Create a new Fiserv DNA record

post
Body
IsValidbooleanOptionalExample: true
PersonNumbernumber · floatOptionalExample: 123456789
Responses
200
Successful operation
post
POST /fiservdna HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2460

{
  "Addresses": [
    {
      "CensusTractNumber": "123456",
      "CityName": "Philadelphia",
      "CountryCode": "US",
      "CountrySubdivisionCode": "PA",
      "IsAddressChange": true,
      "AddressLines": [
        {
          "AddrLineTypCd": "STR",
          "Value": "123 Main St"
        }
      ],
      "MailCode": "MAILCODE123",
      "ShouldUpdate": true,
      "SMSANumber": "98765",
      "State": "PA",
      "UseCode": "RES",
      "ZipCode": "19103",
      "ZipSuffix": "1234",
      "SeasonalAddress": [
        {
          "StartDate": "2023-05-01",
          "StartDayNbr": 1,
          "StartMonthCd": "05",
          "StopDate": "2023-10-01",
          "StopDayNbr": 1,
          "StopMonthCd": "10"
        }
      ]
    }
  ],
  "Demographics": {
    "CreditRating": "EXCELLENT",
    "CustomerTypeCode": "IND",
    "EducationLevel": "BACHELOR",
    "GradDate": "2020-05-15",
    "IncomeLevel": "75000-100000",
    "IsAllowPromCallsMsgs": true,
    "MailTypeCode": "PAPER",
    "MemberGroupCode": "VIP",
    "Occupation": "Software Engineer",
    "OwnOrRent": "OWN",
    "PreferredLocaleCode": "EN_US",
    "PrivacyRequested": true,
    "SpousePersonNumber": 123456,
    "TaxCountryCode": "US"
  },
  "EmailAddresses": [
    {
      "addrUseCode": "PERSONAL",
      "IsDelete": true,
      "ElectronicAddressLines": [
        {
          "AddrLine": "[email protected]"
        }
      ]
    }
  ],
  "ForeignTaxIds": [
    {
      "TaxIdApplyDate": "2022-01-01",
      "TaxIdCertDate": "2022-02-01",
      "CountryCode": "US",
      "TaxIdNbr": "123-45-6789",
      "TaxIDTyp": "SSN"
    }
  ],
  "HSAData": {
    "EmployerOrgNumber": 98765,
    "IDVettingStatusCode": "APPROVED",
    "OFACVettingStatusCode": "CLEARED",
    "VettDate": "2023-01-15",
    "VettingEffDate": "2023-01-20"
  },
  "Identification": {
    "CustKeyWord": "SECRETKEY",
    "DateOfBirth": "1985-05-20",
    "DateOfDeath": "2075-10-01",
    "ForeignCertExpirationDate": "2030-12-31",
    "TaxIdApplyDate": "2000-01-01",
    "TaxIdCertDate": "2000-02-01",
    "TaxPayerNumber": "123-45-6789"
  },
  "IsValid": true,
  "Name": {
    "FirstName": "John",
    "LastName": "Doe",
    "MiddleInitial": "A",
    "MiddleName": "Allen",
    "NickName": "Johnny",
    "SalutationCode": "Mr.",
    "Suffix": "Jr."
  },
  "PersExtOrgIds": [
    {
      "ExternalId": "EXT12345",
      "ExternalIdTypeCode": "EMPLOYEE_ID",
      "ExternalOrgNumber": 123456
    }
  ],
  "PersIds": [
    {
      "CountryCode": "US",
      "CountrySubdivisionCode": "PA",
      "ExpireDate": "2025-12-31",
      "IssueDate": "2020-01-01",
      "LastVerificationDate": "2023-06-01",
      "StateCode": "PA",
      "PersIdTypeCode": "DRIVER_LICENSE",
      "IdValue": "123456789"
    }
  ],
  "PersonNumber": 123456789,
  "PersTyps": [
    {
      "PersonTypeCode": "INDIVIDUAL",
      "EffectiveDate": "2023-01-01",
      "RemoveTypeCode": true
    }
  ],
  "Phones": [
    {
      "AreaCode": "215",
      "PhoneCode": "MOBILE",
      "CountryCode": "1",
      "Exchange": "555",
      "Extension": "1234",
      "ForeignPhoneNumber": "+44 20 7946 0958",
      "IsPreferred": true,
      "PhoneLastUpdatedDate": "2023-07-15",
      "Number": "555-1234",
      "ShouldDelete": true,
      "ShouldUpdate": true,
      "UsageCode": "BUSINESS"
    }
  ],
  "UserFields": [
    {
      "Code": "CUSTOM_FIELD_1",
      "Value": "Value1"
    }
  ]
}
No content

Documentation of available fields with examples

Addresses

  • CensusTractNumber: A numerical code representing a small geographic region used for statistical purposes by the US Census Bureau. Example: "123456"

  • CityName: The name of the city where the address is located. Example: "Philadelphia"

  • CountryCode: A standardized two-letter code representing the country. Example: "US"

  • CountrySubdivisionCode: The code representing the country's primary subdivision, such as a state or province. Example: "PA" (Pennsylvania)

  • IsAddressChange: A boolean flag indicating if the address has recently been changed. Example: true

  • AddressLines:

    • AddrLineTypCd: The type code for the address line, indicating if it is a street address, PO box, etc. Example: "STR" (Street), "POB" (PO Box)

    • Value: The actual address line value. Example: "123 Main St"

  • MailCode: A code used for mailing purposes. Example: "MAILCODE123"

  • ShouldUpdate: A boolean indicating if the address information needs to be updated in the system. Example: true

  • SMSANumber: Standard Metropolitan Statistical Area number. Example: "98765"

  • State: The state where the address is located. Example: "PA"

  • UseCode: A code representing the use of the address. Example: "RES" (Residential), "BUS" (Business)

  • ZipCode: The primary postal code. Example: "19103"

  • ZipSuffix: The extended part of the ZIP code for more precise location identification. Example: "1234"

  • SeasonalAddress:

    • StartDate: The start date of the seasonal address. Example: "2023-05-01"

    • StartDayNbr: The start day number of the seasonal address. Example: 1

    • StartMonthCd: The start month code of the seasonal address. Example: "05" (May)

    • StopDate: The stop date of the seasonal address. Example: "2023-10-01"

    • StopDayNbr: The stop day number of the seasonal address. Example: 1

    • StopMonthCd: The stop month code of the seasonal address. Example: "10" (October)

Demographics

  • CreditRating: The credit rating of the individual. Example: "EXCELLENT"

  • CustomerTypeCode: The customer type code. Example: "IND" (Individual), "BUS" (Business)

  • EducationLevel: The education level of the individual. Example: "BACHELOR"

  • GradDate: The graduation date. Example: "2020-05-15"

  • IncomeLevel: The income level of the individual. Example: "75000-100000"

  • IsAllowPromCallsMsgs: Boolean indicating if promotional calls/messages are allowed. Example: true

  • MailTypeCode: The mail type code. Example: "PAPER", "EMAIL"

  • MemberGroupCode: The member group code. Example: "VIP", "REGULAR"

  • Occupation: The occupation of the individual. Example: "Software Engineer"

  • OwnOrRent: Indicates if the individual owns or rents. Example: "OWN", "RENT"

  • PreferredLocaleCode: The preferred locale code. Example: "EN_US"

  • PrivacyRequested: Boolean indicating if privacy is requested. Example: true

  • SpousePersonNumber: The person number of the spouse. Example: 123456

  • TaxCountryCode: The tax country code. Example: "US"

EmailAddresses

  • addrUseCode: The address use code. Example: "PERSONAL", "BUSINESS"

  • IsDelete: Boolean indicating if the email address should be deleted. Example: true

  • ElectronicAddressLines:

ForeignTaxIds

  • TaxIdApplyDate: The tax ID apply date. Example: "2022-01-01"

  • TaxIdCertDate: The tax ID certification date. Example: "2022-02-01"

  • CountryCode: The country code. Example: "US"

  • TaxIdNbr: The tax ID number. Example: "123-45-6789"

  • TaxIDTyp: The tax ID type. Example: "SSN", "EIN"

HSAData

  • EmployerOrgNumber: The employer organization number. Example: 98765

  • IDVettingStatusCode: The ID vetting status code. Example: "APPROVED"

  • OFACVettingStatusCode: The OFAC vetting status code. Example: "CLEARED"

  • VettDate: The vetting date. Example: "2023-01-15"

  • VettingEffDate: The vetting effective date. Example: "2023-01-20"

Identification

  • CustKeyWord: The customer keyword. Example: "SECRETKEY"

  • DateOfBirth: The date of birth. Example: "1985-05-20"

  • DateOfDeath: The date of death. Example: "2075-10-01"

  • ForeignCertExpirationDate: The foreign certification expiration date. Example: "2030-12-31"

  • TaxIdApplyDate: The tax ID apply date. Example: "2000-01-01"

  • TaxIdCertDate: The tax ID certification date. Example: "2000-02-01"

  • TaxPayerNumber: The taxpayer number. Example: "123-45-6789"

IsValid

  • IsValid: Boolean indicating if the record is valid. Example: true

Name

  • FirstName: The first name. Example: "John"

  • LastName: The last name. Example: "Doe"

  • MiddleInitial: The middle initial. Example: "A"

  • MiddleName: The middle name. Example: "Allen"

  • NickName: The nickname. Example: "Johnny"

  • SalutationCode: The salutation code. Example: "Mr.", "Mrs.", "Dr."

  • Suffix: The suffix. Example: "Jr.", "Sr.", "III"

PersExtOrgIds

  • ExternalId: The external ID. Example: "EXT12345"

  • ExternalIdTypeCode: The external ID type code. Example: "EMPLOYEE_ID"

  • ExternalOrgNumber: The external organization number. Example: 123456

PersIds

  • CountryCode: The country code. Example: "US"

  • CountrySubdivisionCode: The country's subdivision code. Example: "PA"

  • ExpireDate: The expiration date. Example: "2025-12-31"

  • IssueDate: The issue date. Example: "2020-01-01"

  • LastVerificationDate: The last verification date. Example: "2023-06-01"

  • StateCode: The state code. Example: "PA"

  • PersIdTypeCode: The personal ID type code. Example: "DRIVER_LICENSE"

  • IdValue: The ID value. Example: "123456789"

PersonNumber

  • PersonNumber: A unique identifier for the person. Example: 123456789

PersTyps

  • PersonTypeCode: The person type code. Example: "INDIVIDUAL", "BUSINESS"

  • EffectiveDate: The effective date. Example: "2023-01-01"

  • RemoveTypeCode: Boolean indicating if the person type should be removed. Example: true

Phones

  • AreaCode: The area code of the phone number. Example: "215"

  • PhoneCode: The phone code. Example: "MOBILE", "HOME"

  • CountryCode: The country code of the phone number. Example: "1"

  • Exchange: The exchange part of the phone number. Example: "555"

  • Extension: The extension number, if applicable. Example: "1234"

  • ForeignPhoneNumber: The foreign phone number, if applicable. Example: "+44 20 7946 0958"

  • IsPreferred: Boolean indicating if this is the preferred phone number. Example: true

  • PhoneLastUpdatedDate: The date the phone number was last updated. Example: "2023-07-15"

  • Number: The phone number. Example: "555-1234"

  • ShouldDelete: Boolean indicating if the phone number should be deleted. Example: true

  • ShouldUpdate: Boolean indicating if the phone number should be updated. Example: true

  • UsageCode: The usage code of the phone number. Example: "BUSINESS", "PERSONAL"

UserFields

  • Code: A custom code representing the user-defined field. Example: "CUSTOM_FIELD_1"

  • Value: The value of the user-defined field. Example: "Value1"

PreviousSandbox Mock Core

Last updated

Was this helpful?

#178:

Change request updated