POST /consentAndDocuments

post

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

Used to verify consent, create a pull, and upload documents.

Body Params

device_identifier

string

required

User's IP address or other unique user identifier

terms_version

integer

required

Must correspond to the terms_version that was presented to the user

consent_language

string

required

length ≤ 1024

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

public_alias

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

insurerName

string | null

Carrier ID to submit the credentials to

documents

array of files

required

length between 1 and 20

Insurance documents. Max size per file is 10MB. Max combined size is 200MB.

Example adding files to formdata:

const formData = new FormData();
formData.append('documents', file1);
formData.append('documents', file2);

documents*

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 Response Schema