Reference : What the individual fields in the sidecar file are for
1. Sidecar file for issuance to individuals
| Field | Description | Remarks |
|---|---|---|
| identificationType | identifier of the user | allowable values : NRIC, FIN or Passport |
| uin | actual value of identifier | eg. SxxxxxxxX |
| nationality (optional) | nationality of user | mandatory only if identificationType is Passport. |
| name | recipient’s name | eg. Johnathan Ng Chee Tiong |
| recipient’s email address | only 1 email address is allowed. | |
| dob (optional) | recipient’s date of birth | provide in the yyyy-mm-dd format. mandatory only if isNonSingpassRetrievable is TRUE, else leave blank otherwise. |
| localMobileNumber | recipient’s mobile number | eg. 6599999999. does not support foreign numbers currently. |
| isNonSingpassRetrievable | indicator whether to allow retrieval via Singpass only or to also support non-Singpass retrieval | allowable values : TRUE or FALSE |
| applicationType | identifier of document in FileSG | provided by FileSG upon successful on-boarding. do not change. eg. LTVP |
| externalRefId | agency’s own identifier. | useful for trouble shooting purposes with agency in the event that user encounters any issues with the issued document. eg. <agency’s case number> |
| transactionName | short description of the issuance | used as the email subject in the notification email. eg. Your certificate of xxxxxx has been approved and issued! Sample of issuance email Sample of activity page in FileSG |
| files | file name(s) | name of file(s) to be issued to recipient (relative path to the sidecar file within the zip). can be 1 or more. eg. abcd.pdf or abcd.pdf;efgp.pdf (semi colon seperated for multiple files) |
| filesToEncrypt | file name(s) that requires password protection | name of file(s) (pdf or zip only) that requires password protection. |
| deleteAt | date which file(s) will be removed from FileSG | provide in the yyyy-mm-dd format. file(s) will be available for user retrieval till (deleteAt date), after which they will be removed. |
| expireAt | date which OA file(s) will be cancelled/revoked | provide in the yyyy-mm-dd format. file(s) will be valid till (expireAt date - 1). |
| txnMsgId | template ID | provided by FileSG upon successful on-boarding. do not change. eg. LTVP |
| txnMsg_<para1 … paraX> | dynamic parameter name in template | no of rows will depend on the notification message (provided by agency) |
| notificationId_email | template ID | provided by FileSG upon successful on-boarding. do not change. eg. LTVP |
| notification_email_<para1 … paraX> | dynamic parameter name in template | no of rows will depend on the notification message (provided by agency) |
2. Sidecar file for issuance to commercial entities
| Field | Description | Remarks |
|---|---|---|
| uen | uen number of the company | |
| corporateName | name of company | this is used in the notification email and within the FileSG interface |
| email address of the recipient(s) | can be 1 or more. eg. abc@gmail.com or abc@gmail.com;efg@gmail.com (semi colon seperated for multiple files) |
|
| applicationType | identifier of document in FileSG | provided by FileSG upon successful on-boarding. do not change. eg. LTVP |
| externalRefId | agency’s own identifier. | useful for trouble shooting purposes with agency in the event that user encounters any issues with the issued document. eg. <agency’s case number> |
| transactionName | short description of the issuance | used as the email subject in the notification email. eg. Your certificate of xxxxxx has been approved and issued! Sample of issuance email Sample of activity page in FileSG |
| files | file name(s) | name of file(s) to be issued to recipient (relative path to the sidecar file within the zip). can be 1 or more. eg. abcd.pdf or abcd.pdf;efgp.pdf (semi colon seperated for multiple files) |
| filesToEncrypt | file name(s) that requires password protection | name of file(s) (pdf or zip only) that requires password protection. |
| deleteAt | date which file(s) will be removed from FileSG | provide in the yyyy-mm-dd format. file(s) will be available for user retrieval till (deleteAt date), after which they will be removed. |
| expireAt | date which OA file(s) will be cancelled/revoked | provide in the yyyy-mm-dd format. file(s) will be valid till (expireAt date - 1). |
| txnMsgId | template ID | provided by FileSG upon successful on-boarding. do not change. eg. LTVP |
| txnMsg_<para1 … paraX> | dynamic parameter name in template | no of rows will depend on the notification message (provided by agency) |
| notificationId_email | template ID | provided by FileSG upon successful on-boarding. do not change. eg. LTVP |
| notification_email_<para1 … paraX> | dynamic parameter name in template | no of rows will depend on the notification message (provided by agency) |
