Client Customer Account File
  • 15 Apr 2025
  • 4 Minutes to read
  • Dark
    Light

Client Customer Account File

  • Dark
    Light

Article summary

The Client Customer Account (CCA) file is used to populate the Relay system with valid Customer or Patient records. These records are used to validate a Customer or Patient when they are onboarded via any enabled onboarding channel.

  • CSV File Types

  • CCA CSV File

Data File Properties: Client Customer Account

Property

Data Type

Length

Required

Description

ccid

string

100

Yes

The unique identifier of the Customer.

product_group

string

100

Yes

The current product group identifier of the Customer. An account is associated to one and only one product group at a time.

secondary_account_id

string

100

No

This field can be used to tie the Customer back to another external system.

first_name

string

100

No

The first name of the Customer or Patient.

middle_name

string

100

No

The middle name of the Customer or Patient.

last_name

string

100

No

The last name of the Customer or Patient.

address1

string

100

No

Identifies the first line of the Customer's or Patient's address.

address2

string

100

No

Identifies the second line of the Customer's or Patient's address.

city

string

100

No

Identifies the city of the Customer's or Patient's address.

state_province

string

2

No

Identifies the state or province of the Customer's or Patient's address.

postal_code

string

10

No

Identifies the postal code of the Customer's or Patient's address.

country

string

2

No

Identifies the country of the Customer's or Patient's address.

date_of_birth

date

No

Identifies the date of birth of the Customer or Patient.

Format: yyyy-mm-dd

ssn_last4

string

4

No

The last 4 digits of the Customer's or Patient's social security number.

gender

string

1

No

Identifies the gender of the Customer or Patient.

ext_xxx

string

100

No

Client defined, extensible properties to be stored with the Customer or Patient record. Each extensible property must be defined with a prefix "ext_".

  • Custom ext_ properties are provided by the Client.
  • Zero or more ext_ properties can be provided.
  • Different ext_ properties can be provided for each Customer or Patient.
  • The maximum length of each ext_ property is 100 characters.

EXT_LANG

string

100

No

This field can be used to designate whether the users's feed should be in English or Spanish.  The header is case sensitive.  Please work with your Relay Account team to ensure you have Spanish feed settings enabled as well.

Values

ES The user's feed should be in Spanish

EN or Null The user's feed should be in English

Sample File:

cca-with-custom-fields
302 Byte

Rejection Files

A rejection report will be posted for each input file provided to Relay.  The report will take on the name of the input file, with "REJECT-" appended to the front of the filename.

  • Files are posted to the SFTP pickup folder/sub-folder matching the file type.  See File Transmissions

  • File formats match the input file format with the addition of an Errors column at the beginning of the file that includes the reason a record was rejected

Rejection Reasons:

Error Message

Description

Ccid exceeds allowed length (100)

The number of characters provided in this field exceeds the limit for the field

Ccid contains whitespace

There is whitespace detected in your CCID field and this is not accepted.  The whitespace should be removed in order to process the record.  Hint: If not immediately visible, check to see if there was a whitespace added to the end of the CCID

Ccid not provided

There was no value in the CCID field, and this is a required field

Product group exceeds allowed length (100)

The number of characters provided in this field exceeds the limit for the field

Product group not provided

There was no value in the PRODUCT_GROUP field, and this is a required field

Secondary account id exceeds allowed length (100)

The number of characters provided in this field exceeds the limit for the field

First name exceeds allowed length (100)

The number of characters provided in this field exceeds the limit for the field

Middle name exceeds allowed length (100)

The number of characters provided in this field exceeds the limit for the field

Last name exceeds allowed length (100)

The number of characters provided in this field exceeds the limit for the field

Address1 exceeds allowed length (100)

The number of characters provided in this field exceeds the limit for the field

Address2 exceeds allowed length (100)

The number of characters provided in this field exceeds the limit for the field

City exceeds allowed length (100)

The number of characters provided in this field exceeds the limit for the field

State province exceeds allowed length (2)

The number of characters provided in this field exceeds the limit for the field

Postal code exceeds allowed length (10)

The number of characters provided in this field exceeds the limit for the field

Country exceeds allowed length (2)

The number of characters provided in this field exceeds the limit for the field

Country expected as 2 alpha characters

The number of characters provided in this field exceeds the limit for the field

Date of birth expected as yyyy-mm-dd

The value provided in the DATE_OF_BIRTH field was in a different format than expected.  The format should be yyyy-mm-dd.  

Hint: Re-opening a .csv file can cause the format to revert back to a different format.  If you have to open the file for any reason prior to processing, we recommend updating the format for this field proactively.

Ssn last4 expected as 4 numerical digits

The number of characters provided in this field exceeds the limit for the field

Gender expected as 1 alpha character

The number of characters provided in this field exceeds the limit for the field

Invalid product group: product_group

The value provided in the product group field does not match any of the values in CX Builder.  Verify the product_group values with your Relay Account Team members.


Was this article helpful?

ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence