Routes

Initiate wealth data collection

Initiate a pension/investment data collection for a specific individual. Calling this will trigger the selected login method.

POSThttps://api.insurely.com/wealth/collection

Header Parameters

Insurely-Versionstring

Enum:["2024-06-01"]

Request Body

companystring

The name of the company to trigger the collection from

consentsArray<ConsentRequestInput>

A set of consents provided by the end user.

inputobject

Key-value object specifying additional input required for the collection. What values should be included depends on context.

loginMethodstring

Login method that will be used to authenticate the user. Available login methods for a company is specified in the `/companies/availability` response.

Possible Enum values are FRENCH_TRUST_ME, or FRENCH_IMPOTS_GOUV.

Responses

companystring

Company that this collection is from

extraInformationCollectionStatusInformationMap

A key-value map containing potential extra information, depending on the company the collection is getting data from.

idstring

The collection ID of the request

pollingTimeoutstring[date-time]

The collection status must be polled before this timestamp. Failure to do so may result in the termination of the collection.

statusstring

Current status of the collection.

Possible Enum values are RUNNING, LOGIN, TWO_FACTOR_PENDING, CONTACT_FORM_PENDING, COLLECTION_INPUT_PENDING, COLLECTION_INPUT_TIMEOUT, COLLECTING, COMPLETED, COMPLETED_PARTIAL, COMPLETED_EMPTY, FAILED, FAILED_PDF_PARSE, FAILED_PDF_USER_INPUT, AUTHENTICATION_TIMEOUT, WAITING_FOR_USER_ACTION, INCORRECT_CREDENTIALS, AUTHENTICATION_CANCELLED, AUTHENTICATION_CONFLICT, ACCOUNT_TEMPORARILY_LOCKED, AUTHENTICATION_MISMATCH, KYC_FORM, CONTACT_FORM, CUSTOMER_ENROLLMENT_REQUIRED, or THIRD_PARTY_ERROR.
cURL
curl https://api.insurely.com/wealth/collection \  -X POST