Pull

Pull

fieldtypedescriptionproperties
pull_idstring(uuid)ID of the pull
statusPull Status. Certain statuses correspond with a certain type:
- GETTING_CONSUMERS and PULLING_DATA are for PULLING_DATA pulls only.
- SERVICING, WAITING_FOR_CONSUMER_CONFIRMATION, SUBMITTING_CONFIRMATION and VALIDATION_ERROR are for SERVICING pulls only.
- All other statuses can be present on any pull type.
enum: STARTED, QUEUED, PROCESSING, IDENTITY_VERIFICATION_OPTIONS, IDENTITY_VERIFICATION, GETTING_CONSUMERS, PULLING_DATA, SERVICING, WAITING_FOR_CONSUMER_CONFIRMATION, SUBMITTING_CONFIRMATION, NOT_AUTHENTICATED, INTERNAL_ERROR, PROVIDER_ERROR, VALIDATION_ERROR, SUCCESS
account_identifierstringUnique identifier for online account holder that will stay the same across multiple pulls
first_namestring | nullFirst name of online account holder
middle_namestring | nullMiddle name of online account holder
last_namestring | nullLast name of online account holder
emailstring(email) | nullEmail optionally provided by consumer after submitting bad credentials (NOT_AUTHENTICATED)
account_emailstring(email) | nullOnline account holder email address
phonestring | nullPreferred contact phone
mobile_phonestring | nullOnline account holder mobile phone
home_phonestring | nullOnline account holder home phone
work_phonestring | nullOnline account holder work phone
work_phone_extensionstring | nullOnline account holder work phone extension
insurance_provider_namestring | nullOnline account holder's insurance provider identifier. This is not a user-friendly name.
insurance_provider_friendly_namestring | nullOnline account holder's insurance provider name. This is a user-friendly name.
team_idstring(uuid)Team ID this pull is associated with (should match the team id used or api call)
widget_idstring(uuid)Widget/Link Id that the online account holder submitted on
meta_datastring | nullDeveloper-supplied arbitrary JSON-serializable data as a string
is_archivedbooleanWhether the pull is archiveddefault: false
created_atstring(date-time)Time at which the pull was created by online account holder giving consent
public_aliasstringUrl alias/extension of the Canopy Connect link where the pull was submitted
public_urlstringFull public url used to create pull
encountered_mfabooleanWhether the Pull encountered MFA
no_policiesbooleanWhether the account has no policies
no_driversbooleanWhether the account has no drivers
no_documentsbooleanWhether the account has no documents
no_claimsbooleanWhether the account has no claims
no_loss_eventsbooleanWhether the account has no loss events
typestringPull Typeenum: PULLING_DATA, SERVICING, DOCUMENT_UPLOAD, DOCUMENT_PARSING
policiesarrayList of policy objectsReferences Policy
driversarrayList of vehicle objectsReferences Driver
documentsarrayList of document objectsReferences Document
addressesarrayList of address objectsReferences Address
claimsarrayList of claim objectsReferences Claim
driving_recordsarrayList of driving record objectsReferences DrivingRecord
loss_eventsarrayList of commercial loss events objectsReferences LossEvent
agentsarrayList of agent objectsReferences AgentInfo
answersarrayList of answers to custom fields in the link flowReferences AnswerSection