Transfer Note

Authorizations

X-API-Key

string

header

required

Body

application/json

Transfer note data

customerId

string

required

Unique identifier for the customer

Example:

"customer-12345"

summary

string

required

AI-generated summary of the call including verification status, employment details, banking information, and other key information gathered during the conversation

Example:

"In call, person was verified as Mark Scout. Mark Scout works for Lumon Industries as a Macrodata Refinement Engineer. Mark Scout has a direct deposit and a checking account. Mark Scout is employed full time and has a recent direct deposit. Mark Scout is not active military. Mark Scout is not receiving financial assistance. Mark Scout is paid monthly. His payment frequency is weekly. Mark Scout is not on any specific day of the week. Mark Scout does not have a do not call before date. Mark Scout is not spamming text messages. Mark Scout has no additional notes."

answers

object

required

Free-form object containing all collected information from the call. Common fields include contact information, employment details, banking information, verification status, and preferences. Fields may vary based on the conversation flow.

Show child attributes

answers.date_of_birth

string<date>

Customer's date of birth in YYYY-MM-DD format

Example:

"1990-01-01"

answers.state

string

Two-letter state code

Example:

"CO"

answers.personal_phone_1

string

Primary phone number

Example:

"+16508629110"

answers.personal_phone_1_contact

string

Whether contact was made on this number

Example:

"Yes"

answers.employer_phone

string

Employer's phone number

Example:

"+16508629114"

answers.speaking_to_customer

string

Whether speaking directly to the customer

Example:

"Yes"

answers.active_military

string

Active military status

Example:

"No"

answers.currently_employed

string

Current employment status

Example:

"Employed"

answers.company_name

string

Name of employer

Example:

"Lumon Industries"

answers.home_address_1

string

Street address

Example:

"123 Main St"

answers.home_city

string

City

Example:

"Denver"

answers.home_state

string

State code

Example:

"CO"

answers.zipcode

string

ZIP code

Example:

"80201"

answers.direct_deposit

string

Whether customer has direct deposit

Example:

"Yes"

answers.checking_account

string

Checking account status

Example:

"Direct Deposit"

Response

200

Return a 200 status to indicate that the data was received successfully

API Documentation

Endpoint Examples

Authorizations

Body

Response