The finishAppUrl parameter
Add a step after Indeed Apply.
- By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.
What is finishAppUrl?
#finishAppUrl adds a step after Indeed Apply. The application stays incomplete until the job seeker finishes it.
Use it for steps Indeed Apply does not support:
- Third-party verification, such as a background check.
- Video interview.
- Work sample.
- Assessment.
- Complex, relational, or checkbox screener questions.
- Legal forms in a required format. Ask your legal team.
Indeed encrypts the parameters you add to finishAppUrl and sends them to you when the extra step starts. POST data can arrive later.
Indeed does not approve finishAppUrl for these uses:
| Do not use for | Description |
|---|---|
| Redundant questions | Do not repeat Indeed Apply questions. |
| Account creation | Job seekers create accounts with Indeed OAuth. |
To use this function with the Job Sync API, see the finishApplicationUrl field and applyMethod field.
Criteria for finishAppUrl access
#Spend requirements apply only to new users. Existing users keep their current finishAppUrl setup.
-
In the US, CA, BE, CH, DE, ES, FR, GB, IE, and NL:
- Fewer than 1,000 jobs on Indeed: spend more than USD 300,000 a year.
- 1,000 or more jobs on Indeed: spend more than USD 500,000 a year.
-
In all other countries:
- Fewer than 1,000 jobs on Indeed: spend more than USD 50,000 a year.
- 1,000 or more jobs on Indeed: spend more than USD 100,000 a year.
Only searchable and sponsored jobs count.
The extra step must:
- Keep the application incomplete until the job seeker finishes it.
- Show every applicant from Indeed, including job seekers who stop early. Mark those applications incomplete.
- Work well on mobile.
- Use a domain on the Indeed allowlist. Otherwise, job seekers see a pop-up before the redirect.
Do not use it without approval from Indeed. If Indeed finds that you use the parameter incorrectly, it can disable your integration until you fix the issues. To request access to finishAppUrl for an employer, contact the employer's Indeed representative.
Steps
#1. Implement finishAppUrl
#Set finishAppUrl with this table. For other parameters, use the Indeed Apply integration guide for direct employers or the Indeed Apply configuration parameter restrictions.
| Parameter name | Required | Description | Example |
|---|---|---|---|
finishAppUrl | No | URL opened after Continue on the confirmation page. URL-encode it in XML. | http%3A%2F%2Fwww.apply.com%2Fapply%3FindeedID%3D%7Bindeed_apply_id%7D%26email%3D%7Bemail%7D%26phone%3D%7Bphone%7D |
2. Include the pingback
#Notify Indeed at this URL when the job seeker finishes the extra step:
https://apply.indeed.com/indeedapply/finish_application?indeed_apply_id=<YOUR_ID>&api_token=<YOUR_TOKEN>| Parameter | Description |
|---|---|
indeed_apply_id | id field in the application POST data. |
api_token | Public API token from Indeed. |
Supported finishAppUrl parameters
#Add these parameters in any order. Map each value to any variable in the URL.
indeed_apply_id— Application ID.name— Full name. Sent by default and whendata-indeed-apply-nameisfullname.email— Email address.phone— Phone number, if entered.firstname— First name. Sent only whendata-indeed-apply-nameisfirstlastname.lastname— Last name. Sent only whendata-indeed-apply-nameisfirstlastname.
Example of finishAppUrl
#data-indeed-apply-finishappurl="https://www.example.com/applyId={indeed_apply_id}&name={name}&email={email}&phone={phone}"3. Encrypt and decrypt a value
#Indeed encrypts the parameters and sends them to your URL after the job seeker finishes Indeed Apply.
Use AES-CBC with PKCS5 padding. The key is the first 16 bytes of your secret key. The initialization vector is 16 bytes of 00.
To encrypt a value:
- 1.Copy the first 16 bytes of your secret key.
- 2.Encode the value as UTF-8. The examples use an email address.
- 3.Encrypt with AES-CBC and PKCS5 padding.
- 4.Write the result as a hex string.
See Encryption and decryption examples.
Encryption and decryption examples
#using System.Text;using System.IO;using System;using System.Security.Cryptography;
public class IA_email_encryption_test{ public static void Main(string[] args) { string email = "john.doe@example.com"; string key = "your api secret key";
// only use first 16 bytes of the key byte[] keybytes = Encoding.UTF8.GetBytes(key); byte[] truncatedkeybytes = new byte[16]; Array.Copy(keybytes, truncatedkeybytes, 16); // initialization vector is all 0's; no additonal initilization required byte[] iv = new byte[16];
byte[] ciphertext = Encrypt(email, truncatedkeybytes, iv);
string hexciphertext = ByteArrayToHexString(ciphertext);
if ( !hexciphertext.Equals( "eaaacff9df2e4c2a63083a303d4521f0bd41e375232a2895310179bc030addfb" ) ) { Console.WriteLine("invalid encrypted value!"); } else { Console.WriteLine("hex encoded encrypted email: " + hexciphertext); // we decrypt merely as an exercise string decrypted = Decrypt(ciphertext, truncatedkeybytes, iv); Console.WriteLine("Decrypted E-mail: " + decrypted); } }
public static byte[] Encrypt(string plainText, byte[] key, byte[] iv) { var cypher = new AesManaged(); cypher.Mode = CipherMode.CBC; cypher.Padding = PaddingMode.PKCS7; cypher.KeySize = 128; cypher.BlockSize = 128; cypher.Key = key; cypher.IV = iv;
var icTransformer = cypher.CreateEncryptor(); var msTemp = new MemoryStream();
var csEncrypt = new CryptoStream(msTemp, icTransformer, CryptoStreamMode.Write); var sw = new StreamWriter(csEncrypt); sw.Write(plainText); sw.Close(); sw.Dispose();
csEncrypt.Clear(); csEncrypt.Dispose();
byte[] bResult = msTemp.ToArray();
return bResult; }
public static string Decrypt(byte[] ciphertext, byte[] key, byte[] iv) { var cypher = new AesManaged(); cypher.Mode = CipherMode.CBC; cypher.Padding = PaddingMode.PKCS7; cypher.KeySize = 128; cypher.BlockSize = 128; cypher.Key = key; cypher.IV = iv;
var icTransformer = cypher.CreateDecryptor(); var msTemp = new MemoryStream(ciphertext);
var csDecrypt = new CryptoStream(msTemp, icTransformer, CryptoStreamMode.Read); var sr = new StreamReader(csDecrypt);
string plaintext = sr.ReadToEnd();
csDecrypt.Clear(); csDecrypt.Dispose();
return plaintext; }
private static string ByteArrayToHexString(byte[] bytes) { StringBuilder sbHex = new StringBuilder(); foreach (byte b in bytes) sbHex.AppendFormat("{0:x2}", b); return sbHex.ToString(); }}import java.nio.ByteBuffer;import java.nio.charset.Charset;import java.lang.RuntimeException;import javax.crypto.Cipher;import javax.crypto.spec.*;import javax.crypto.spec.SecretKeySpec;public class Main { public static void main(String[] args) { String email = "john.doe@example.com"; String apiSecret = "your api secret key"; String encrypted_email = encrypt(email, apiSecret); String decrypted_email = decrypt(encrypted_email, apiSecret); if (encrypted_email.equals("eaaacff9df2e4c2a63083a303d4521f0bd41e375232a2895310179bc030addfb")) { System.out.println("B64 encoded encrypted email: " + encrypted_email); System.out.println("decrypted email: " + decrypted_email); } else { System.out.println("invalid encrypted value!"); } } static String encrypt(String message, String apiSecret) { try { // get api secret bytes byte[] keyBytes = apiSecret.getBytes(Charset.forName("UTF-8")); // get message bytes byte[] message_bytes = message.getBytes("UTF-8"); // note that we only use the first 16 bytes of the key SecretKeySpec key = new SecretKeySpec(keyBytes, 0, 16, "AES"); // get appropriate cipher using PKCS5 padding Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding"); IvParameterSpec ivspec = new IvParameterSpec(new byte[] { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }); cipher.init(Cipher.ENCRYPT_MODE, key, ivspec); // encrypt the message byte[] email_encrypted = cipher.doFinal(message_bytes); // this is the value that should be sent to Indeed return bytesToHexString(email_encrypted); } catch (Exception e) { System.out.println(e.getMessage()); throw new RuntimeException(e); } } static String decrypt(String message, String apiSecret) { try { // get api secret bytes byte[] keyBytes = apiSecret.getBytes(Charset.forName("UTF-8")); // get message bytes byte[] message_bytes = message.getBytes(Charset.forName("UTF-8")); // convert from b64 encoding message_bytes = decodeHex(message_bytes); // Create a SecretKeySpec using api secret // note that we only use the first 16 bytes of the key SecretKeySpec key = new SecretKeySpec(keyBytes, 0, 16, "AES"); // get appropriate cipher using PKCS5 padding Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding"); IvParameterSpec ivspec = new IvParameterSpec(new byte[] { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }); cipher.init(Cipher.DECRYPT_MODE, key, ivspec); // decrypt the message byte[] email_decrypted = cipher.doFinal(message_bytes); return new String(email_decrypted, "UTF-8"); } catch (Exception e) { System.out.println(e.getMessage()); throw new RuntimeException(e); } } static String bytesToHexString(byte[] in) { final StringBuilder builder = new StringBuilder(); for (byte b: in) { builder.append(String.format("%02x", b)); } return builder.toString(); } static byte[] decodeHex(byte[] data) throws Exception { String text = new String(data, "UTF-8"); char[] chars = text.toCharArray(); int len = chars.length; byte[] out = new byte[len >> 1]; int i = 0; for (int j = 0; j < len; ++i) { int f = toDigit(chars[j], j) << 4; ++j; f |= toDigit(chars[j], j); ++j; out[i] = (byte)(f & 255); } return out; } static int toDigit(char ch, int index) throws Exception { int digit = Character.digit(ch, 16); if (digit == -1) { throw new Exception("Illegal hexadecimal character " + ch + " at index " + index); } else { return digit; } }}use Crypt::CBC;use Encode;
# your secret keymy $secret = encode('UTF-8', 'your api secret key');# truncate key to 16 bytesmy $key = substr($secret, 0, 16);# initialization vector of zerosmy $iv = "\0"x 16;# create ciphermy $cipher = Crypt::CBC -> new(-literal_key => 1, -header => 'none', -key => $key, -keysize => 16, -iv => $iv, -cipher => "Crypt::OpenSSL::AES" );# Encrypt the UTF - 8 encoded string into a hex version of the datamy $email_encrypted = $cipher -> encrypt_hex(encode('UTF-8', 'john.doe@example.com'));
if ($email_encrypted eq 'eaaacff9df2e4c2a63083a303d4521f0bd41e375232a2895310179bc030addfb') { print "Hex value of encrypted: $email_encrypted\n"; # Decrypt the hex string to verify whether it is intact my $email_decrypted = $cipher -> decrypt_hex($email_encrypted); print "Decrypted: $email_decrypted\n";} else { print "invalid encrypted value! $email_encrypted\n";}function pkcs5_pad ($text) { $blocksize = 16; $pad = $blocksize - (strlen($text) % $blocksize); $text .= str_repeat(chr($pad), $pad); return $text;}
function pkcs5_unpad($text) { $pad = ord($text{strlen($text)-1}); if ($pad > strlen($text)) return false; if (strspn($text, chr($pad), strlen($text) - $pad) != $pad) return false; return substr($text, 0, -1 * $pad);}
function encrypt($str, $key) { $iv = str_repeat("\0", 16); $str = pkcs5_pad($str); $opts = OPENSSL_RAW_DATA; $encrypted = openssl_encrypt($str, 'AES-128-CBC', $key, $opts, $iv); return $encrypted;}
function decrypt($str, $key) { $iv = str_repeat("\0", 16); $opts = OPENSSL_RAW_DATA; $decrypted = openssl_decrypt($str, 'AES-128-CBC', $key, $opts, $iv); return pkcs5_unpad($decrypted);}
$api_secret = "your api secret key";$email_address = "john.doe@example.com";
// truncate api-secret to first 16 bytes$newkey = mb_strcut($api_secret, 0, 16, "UTF8");// encrypt$encrypted = encrypt($email_address, $newkey);// we decrypt merely as an exercise$decrypted = decrypt($encrypted, $newkey);// this is the value to send to Indeed$encryptedhex = bin2hex($encrypted);if($encryptedhex != "eaaacff9df2e4c2a63083a303d4521f0bd41e375232a2895310179bc030addfba655e21c3309d9343206ae55866764e8") print("invalid encrypted hex value!");print("Hex value of encrypted: " . $encryptedhex . "n");print("Decrypted: " . $decrypted . "n");# https://pypi.python.org/pypi/pycryptodome/3.5.1from Crypto.Cipher import AES
# https://pypi.python.org/pypi/pkcs7/0.1.2from pkcs7 import PKCS7Encoder
# your secret keysecret = "your api secret key".encode("utf-8")# truncate key to 16 byteskey_bytes = secret[0:16]# initialization vector of zerosiv = "\0" * 16# the email address to encryptmessage_plaintext = "john.doe@example.com"# pad the plaintext to 16 byte boundaryPKCS7encoder = PKCS7Encoder()message_plaintext_padded = PKCS7encoder.encode(message_plaintext)# encrypt the message bytescipher = AES.new(key_bytes, AES.MODE_CBC, iv)message_encrypted_raw = cipher.encrypt(message_plaintext_padded)# this is the value that should be sent to Indeedmessage_encrypted_hex = message_encrypted_raw.encode("hex")# we need a new instance for decrypt because the ciphers are statefuldecipher = AES.new(key_bytes, AES.MODE_CBC, iv)# we decrypt here simply as an exercisemessage_decrypted_raw = decipher.decrypt(message_encrypted_raw)# strip paddingmessage_decrypted = PKCS7encoder.decode(message_decrypted_raw)# confirm encrypted valueif ( message_encrypted_hex == "eaaacff9df2e4c2a63083a303d4521f0bd41e375232a2895310179bc030addfb"): print("Hex value of encrypted: " + message_encrypted_hex) print("Decrypted: " + message_decrypted)else: print("invalid encrypted value! " + message_encrypted_hex)# https://pypi.python.org/pypi/pycryptodome/3.5.1from Crypto.Cipher import AES
# https://pypi.python.org/pypi/pkcs7/0.1.2from pkcs7 import PKCS7Encoder
# your secret keysecret = "your api secret key".encode("utf-8")# truncate key to 16 byteskey_bytes = secret[0:16]# initialization vector of zerosiv = bytes("\0" * 16, encoding="UTF-8")# the email address to encryptmessage_plaintext = "john.doe@example.com"# pad the plaintext to 16 byte boundaryPKCS7encoder = PKCS7Encoder()message_plaintext_padded = PKCS7encoder.encode(message_plaintext)# encrypt the message bytesmessage_bytes = message_plaintext_padded.encode("UTF-8")cipher = AES.new(key_bytes, AES.MODE_CBC, iv)message_encrypted_raw = cipher.encrypt(message_bytes)# this is the value that should be sent to Indeedmessage_encrypted_hex = message_encrypted_raw.hex()# we decrypt here simply as an exercisedecipher = AES.new(key_bytes, AES.MODE_CBC, iv)message_decrypted_raw = decipher.decrypt(message_encrypted_raw).decode("UTF-8")# strip paddingmessage_decrypted = PKCS7encoder.decode(message_decrypted_raw)# confirm encrypted valueif ( message_encrypted_hex == "eaaacff9df2e4c2a63083a303d4521f0bd41e375232a2895310179bc030addfb"): print("Hex value of encrypted: " + message_encrypted_hex) print("Decrypted: " + message_decrypted)else: print("invalid encrypted value! " + message_encrypted_hex)https://www.example.com/applyId=6339da3ba0f6f723851334e86a0f7c34cf00f51078cc770b0cace3277f6b99df&name=54fbec6bd96ea2dfbfe3133e7a0af84f&email=977c096217b6636e446066c75a449644&phone=e258e70b1c0e3e7de3d7c0d8e65f290bCompare the encrypted and decrypted values:
| Parameter | Encrypted value | Decrypted value |
|---|---|---|
name | 54fbec6bd96ea2dfbfe3133e7a0af84f | Indeed Tester |
email | 977c096217b6636e446066c75a449644 | test@indeed.com |
phone | e258e70b1c0e3e7de3d7c0d8e65f290b | 1231231234 |
See also
#Guides
#- Indeed Apply — Let job seekers apply to your jobs on Indeed.
- Indeed Apply integration guide for direct employers — Integrate Indeed Apply as a direct employer or on an employer's behalf.
- Job Sync API guide — Shows how to set
applyMethod, includingfinishApplicationUrl, when you create a job.
References
#- Indeed Apply configuration parameter restrictions — Limits on the parameters that configure Indeed Apply in the XML feed.
GraphQL API reference
#SourcedJobPostingIndeedApplyInput— IncludesfinishApplicationUrl, the URL that job seekers visit when they select Continue on the application confirmation page.