DocUpload Widget
Learn how to allow users to prove their identity and address.
Overview
Embed the DocUpload Widget
The DocUpload widget can be embedded into your website using an iFrame at any point of your customer journey when documents proving the user's identity or address need to be uploaded. PNG, JPEG, and PDF formats are accepted, with file dimensions up to 15 MB.
To embed the widget just copy and paste the code below into the UI where you want the widget to be displayed.
Javascript
1<iframe src="https://docupload.newdaycards.com/<brand>?iframe=true&applicationId=<applicationId>"></iframe>| Parameter | Description |
|---|---|
brand(required) | Your brand in a lowercased string format |
iFrame(optional) | Can be either "true" or "false". Defaults to "false" if not provided. |
applicationId(required) | A 36-digit string that identifies the customer application in our databases. The application state property must be 'docrequired'. |
Responses
Whether documents have successfully been uploaded or something went wrong, the widget will post back a payload to the window.parent. From that point onwards, you can decide how to handle each scenario.
Here it is a list of possible scenarios and respective payloads that the widget can send back:
Upload Successful
Javascript
1{
2 "success": true,
3 "status": "documentsUploaded",
4 "message": "User successfully uploaded documents",
5 "applicationId: "{{applicationId}}"
6}Upload Failed
Javascript
1{
2 "success": false,
3 "status": "uploadFailed",
4 "message": "User encountered error",
5 "applicationId: "{{applicationId}}"
6}Customisation
Our widget is built to integrate naturally with your website and brand, providing a consistent user experience.
- Fonts: type, size, and colour
- Buttons: border width, border radius, border colour
- Colours: primary and secondary colours
- Titles (e.g. 'Proof of Identity', 'Proof of address', etc)
- Icons
- List of documents accepted (e.g. Bank statement, UK driving licence, etc.)
- Validity of documents (e.g. Some documents can be either 12 or 3 months old maximum)
- Descriptive and hints copy ('When scanning or taking a photo of your original documents, please make sure to include all four corners of the document')
- Error messages based on API responses (e.g. 'Your file is too big. Please try again.')
Note: Further details can be discussed with your account manager.