Documentation
Start typing to search…

POST /consentAndConnect

post
https://app.usecanopy.com/api/v1.0.0/widget/pull/consentAndConnect

Used to verify consent, create a pull, and start the authentication. Use /connect for reauthentication

Body Params
string
required

User's IP address or other unique user identifier

integer
required

Must correspond to the terms_version that was presented to the user

string
required
length ≤ 1024

Text that was displayed to the user when prompting for their consent

string
required

The widget alias that the pull will be submitted on

meta_data
object

JSON serializable metadata that will be saved to the pull

string
required

Carrier ID to submit the credentials to

string
required
length between 5 and 200

The username token returned by Components

string
length between 5 and 200

The password token returned by Components

string

The thirdfield token returned by Components

servicing_actions
array of objects | null

Will set the pull.type to SERVICING.

servicing_actions
enum

Specify if intending to reuse the credentials and consent from this pull for a future Monitoring or Servicing pull. Will attempt to refresh the session so that the consumer does not need to re-authenticate.

Allowed:
Responses

Updated 5 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago