Skip to navigation
Eligibility

Start a mutual-fund holdings sync

View as Markdown

Asks the customer’s registrar for their holdings. email and mobile are the contact registered on the customer’s folios. For MFCENTRAL, send the customer’s browser to redirect_url, where they enter MF Central’s OTP; for CAMS and KFIN the registrar sends an OTP you submit to …/verify. Needs the MF_HOLDINGS consent.

Authentication

AuthorizationBearer

The token Liquify issued your organisation. Shown once; rotate it from Liquify if it is exposed.

Path parameters

customer_idstringRequired<=64 characters

The customer_id POST /v1/customers returned.

Request

This endpoint expects an object.
providerenumRequired
Allowed values:
emailstringRequiredformat: "email"<=255 characters

The e-mail registered on the customer's folios.

mobilestringRequiredformat: "^[6-9][0-9]{9}$"
Ten digits, no country code.

Response

The sync is started and waits on the customer's OTP.
dataobject
metaobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error