Link Search Menu Expand Document

Fill PDF Forms Simplified Asynchronously - C#

PDF Fill PDF Forms sample in C# demonstrating ‘Fill PDF Forms Simplified Asynchronously’

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.Collections.Generic;
using System.Net;
using System.Threading;

namespace ByteScoutWebApiExample
	class Program
		// The authentication key (API Key).
		// Get your own by registering at
		const String API_KEY = "************************************";
        // Direct URL of source PDF file.
        // You can also upload your own file into and use it as url. Check "Upload File" samples for code snippets:
        const string SourceFileUrl = "";
		// PDF document password. Leave empty for unprotected documents.
		const string Password = "";
		// File name for generated output. Must be a String
		const string FileName = "f1040-form-filled";

		// Destination File Name
		const string DestinationFile = "./result.pdf";

		static void Main(string[] args)
			// Create standard .NET web client instance
			WebClient webClient = new WebClient();

			// Set API Key
			webClient.Headers.Add("x-api-key", API_KEY);

			// Values to fill out pdf fields with built-in pdf form filler
			// To fill fields in PDF form, use the following format page;fieldName;value for example: 0;editbox1;text is here. 
			// To fill checkbox, use true, for example: 0;checkbox1;true. 
			// To separate multiple objects, use | separator. 
			// To get the list of all fillable fields in PDF form please use /pdf/info/fields endpoint.
			var fieldString = "1;topmostSubform[0].Page1[0].f1_02[0];John A. Doe|1;topmostSubform[0].Page1[0].FilingStatus[0].c1_01[1];true|1;topmostSubform[0].Page1[0].YourSocial_ReadOrderControl[0].f1_04[0];123456789";

			// If enabled, Runs processing asynchronously. Returns Use JobId that you may use with /job/check to check state of the processing (possible states: working, 
			var async = true; // (!) Make asynchronous job

			// Prepare requests params as JSON
			// See documentation:
			Dictionary<string, object> parameters = new Dictionary<string, object>();
            parameters.Add("url", SourceFileUrl);
			parameters.Add("name", FileName);
			parameters.Add("password", Password);
            parameters.Add("async", async);
            parameters.Add("fieldsString", fieldString);

            // Convert dictionary of params to JSON
            string jsonPayload = JsonConvert.SerializeObject(parameters);

                // URL of "PDF Edit" endpoint
                string url = "";

                // Execute POST request with JSON payload
                string response = webClient.UploadString(url, jsonPayload);

				// Parse JSON response
				JObject json = JObject.Parse(response);

				if (json["error"].ToObject<bool>() == false)
					// Asynchronous job ID
					string jobId = json["jobId"].ToString();
					// URL of generated PDF file that will available after the job completion
					string resultFileUrl = json["url"].ToString();

					// Check the job status in a loop. 
					// If you don't want to pause the main thread you can rework the code 
					// to use a separate thread for the status checking and completion.
						string status = CheckJobStatus(jobId); // Possible statuses: "working", "failed", "aborted", "success".

						// Display timestamp and status (for demo purposes)
						Console.WriteLine(DateTime.Now.ToLongTimeString() + ": " + status);

						if (status == "success")
							// Download PDF file
							webClient.DownloadFile(resultFileUrl, DestinationFile);

							Console.WriteLine("Generated PDF file saved as \"{0}\" file.", DestinationFile);
						else if (status == "working")
							// Pause for a few seconds
					while (true);
			catch (WebException e)

			Console.WriteLine("Press any key...");

		/// <summary>
		/// Check job status
		/// </summary>
		static string CheckJobStatus(string jobId)
			using (WebClient webClient = new WebClient())
				// Set API Key
				webClient.Headers.Add("x-api-key", API_KEY);

				string url = "" + jobId;

				string response = webClient.DownloadString(url);
				JObject json = JObject.Parse(response);

				return Convert.ToString(json["status"]);
} Web API: the Web API with a set of tools for documents manipulation, data conversion, data extraction, splitting and merging of documents. Includes image recognition, built-in OCR, barcode generation and barcode decoders to decode bar codes from scans, pictures and pdf.

Get your API key here!

Download Source Code (.zip)

return to the previous page explore PDF Fill PDF Forms endpoint