Sidecar field reference

This page is a reference for the fields used in FileSG sidecar files.

Individual

Field	Required?	Description	Notes
`identificationType`	Required	Recipient identifier type	`NRIC`, `FIN`, or `Passport`
`uin`	Required	Recipient identifier	Example: `SxxxxxxxX`
`nationality`	Conditional	Recipient nationality	Required when `identificationType` is `Passport`
`name`	Required	Recipient name	Example: Johnathan Ng Chee Tiong
`email`	Required	Recipient email address	One email address
`dob`	Conditional	Recipient date of birth	`yyyy-mm-dd`; required when `isNonSingpassRetrievable` is `TRUE`
`localMobileNumber`	Required	Recipient mobile number	Current documentation supports local numbers; example `6599999999`
`isNonSingpassRetrievable`	Required	Allows non-Singpass retrieval	`TRUE` or `FALSE`
`applicationType`	Required	FileSG application type	Provided by FileSG; do not change
`externalRefId`	Optional	Agency’s identifier	Useful for troubleshooting
`transactionName`	Required	Short issuance description	Used as the email subject
`files`	Required	Files to issue	One or more filenames; separate multiple files with `;`
`filesToEncrypt`	Optional	Files requiring password protection	PDF or ZIP
`deleteAt`	Optional	Date files are removed	`yyyy-mm-dd`
`expireAt`	Optional	Date OA files stop being valid	`yyyy-mm-dd`; OA validity ends before this date
`txnMsgId`	Required	Transaction message template ID	Provided by FileSG; do not change
`txnMsg_<para1 ... paraX>`	Conditional	Dynamic notification values	Depends on the configured message template
`notificationId_email`	Required	Email notification template ID	Provided by FileSG; do not change
`notification_email_<para1 ... paraX>`	Conditional	Dynamic email template values	Depends on the configured template

Business

Field	Required?	Description	Notes
`uen`	Required	Business UEN	Business identifier
`corporateName`	Required	Business name	Used in the notification and FileSG interface
`email`	Required	Recipient email address(es)	Multiple addresses separated by `;`
`applicationType`	Required	FileSG application type	Provided by FileSG; do not change
`externalRefId`	Optional	Agency’s identifier	Useful for troubleshooting
`transactionName`	Required	Short issuance description	Used as the email subject
`files`	Required	Files to issue	One or more filenames; separate multiple files with `;`
`filesToEncrypt`	Optional	Files requiring password protection	PDF or ZIP
`deleteAt`	Optional	Date files are removed	`yyyy-mm-dd`
`expireAt`	Optional	Date OA files stop being valid	`yyyy-mm-dd`
`txnMsgId`	Required	Transaction message template ID	Provided by FileSG; do not change
`txnMsg_<para1 ... paraX>`	Conditional	Dynamic notification values	Depends on the configured message template
`notificationId_email`	Required	Email notification template ID	Provided by FileSG; do not change
`notification_email_<para1 ... paraX>`	Conditional	Dynamic email template values	Depends on the configured template

Understanding the retrieval switch

isNonSingpassRetrievable controls whether an individual can use the non-Singpass retrieval flow.

Value	Retrieval
`FALSE`	Singpass retrieval
`TRUE`	Singpass and non-Singpass retrieval

When the value is TRUE, dob must be provided.

Country codes

See the Country Code List.

Prepare the sidecar file

Prepare your ZIP file

Chat with me!