Pull
field | type | description | properties |
---|---|---|---|
pull_id | string(uuid) | ID of the pull | |
status | Pull 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_identifier | string | Unique identifier for online account holder that will stay the same across multiple pulls | |
first_name | string | null | First name of online account holder | |
middle_name | string | null | Middle name of online account holder | |
last_name | string | null | Last name of online account holder | |
string(email) | null | Email optionally provided by consumer after submitting bad credentials (NOT_AUTHENTICATED ) | ||
account_email | string(email) | null | Online account holder email address | |
phone | string | null | Preferred contact phone | |
mobile_phone | string | null | Online account holder mobile phone | |
home_phone | string | null | Online account holder home phone | |
work_phone | string | null | Online account holder work phone | |
work_phone_extension | string | null | Online account holder work phone extension | |
insurance_provider_name | string | null | Online account holder's insurance provider identifier. This is not a user-friendly name. | |
insurance_provider_friendly_name | string | null | Online account holder's insurance provider name. This is a user-friendly name. | |
team_id | string(uuid) | Team ID this pull is associated with (should match the team id used or api call) | |
widget_id | string(uuid) | Widget/Link Id that the online account holder submitted on | |
meta_data | string | null | Developer-supplied arbitrary JSON-serializable data as a string | |
is_archived | boolean | Whether the pull is archived | default: false |
created_at | string(date-time) | Time at which the pull was created by online account holder giving consent | |
public_alias | string | Url alias/extension of the Canopy Connect link where the pull was submitted | |
public_url | string | Full public url used to create pull | |
encountered_mfa | boolean | Whether the Pull encountered MFA | |
no_policies | boolean | Whether the account has no policies | |
no_drivers | boolean | Whether the account has no drivers | |
no_documents | boolean | Whether the account has no documents | |
no_claims | boolean | Whether the account has no claims | |
no_loss_events | boolean | Whether the account has no loss events | |
type | string | Pull Type | enum: PULLING_DATA , SERVICING , DOCUMENT_UPLOAD , DOCUMENT_PARSING |
policies | array | List of policy objects | References Policy |
drivers | array | List of vehicle objects | References Driver |
documents | array | List of document objects | References Document |
addresses | array | List of address objects | References Address |
claims | array | List of claim objects | References Claim |
driving_records | array | List of driving record objects | References DrivingRecord |
loss_events | array | List of commercial loss events objects | References LossEvent |
agents | array | List of agent objects | References AgentInfo |
answers | array | List of answers to custom fields in the link flow | References AnswerSection |