Attachment entity
The Attachment entity is used to create files on uP POM. Once the attachment is created, it is used alongside the Document entity to submit supporting documentation.
note
Before you can send the Attachment request, you will need to first encode the file that is to be attached. All files must be encoded using base64.
Field Name | Value | Description | Type |
---|---|---|---|
role | Attachment | Role of the Attachment. Should aways send “Attachment”. | Mandatory |
relatedType | Document | Entity related to the attachment. Should aways send “Document”. | Mandatory |
field | file | Field related to the attachment. Should aways send “file”. * Case sensitive submission | Mandatory |
name | ISO_MCT_BSLC_20230228.pdf | Name of the attached file. | Mandatory |
type | application/pdf | Type of the file. Options are: application/pdf text/plain image/png image/jpg | Mandatory |
file | See the Create Document section of the Merchant Onboarding API Reference | File to be attached encoded using base64. The maximum allowed file length is 6MB The format of the file is: 'data:[type];base64,[base64 encoded file value]' | Mandatory |