[{"data":1,"prerenderedAt":731},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fendpoints":3,"docs-nav":702},{"id":4,"title":5,"body":6,"description":694,"extension":695,"meta":696,"navigation":697,"path":698,"seo":699,"stem":700,"__hash__":701},"docs\u002Fdocs\u002F3.endpoints.md","Endpoints",{"type":7,"value":8,"toc":688},"minimark",[9,13,125,132,205,218,224,267,275,417,420,426,455,462,489,502,508,511,684],[10,11,5],"h1",{"id":12},"endpoints",[14,15,16,35],"table",{},[17,18,19],"thead",{},[20,21,22,26,29,32],"tr",{},[23,24,25],"th",{},"Method",[23,27,28],{},"Path",[23,30,31],{},"What it does",[23,33,34],{},"Billed",[36,37,38,58,75,92,109],"tbody",{},[20,39,40,47,52,55],{},[41,42,43],"td",{},[44,45,46],"code",{},"POST",[41,48,49],{},[44,50,51],{},"\u002Fv1\u002Fcheck",[41,53,54],{},"Check one address",[41,56,57],{},"1 email",[20,59,60,65,70,73],{},[41,61,62],{},[44,63,64],{},"GET",[41,66,67],{},[44,68,69],{},"\u002Fv1\u002Fcheck?email=...",[41,71,72],{},"Same, using the query string",[41,74,57],{},[20,76,77,81,86,89],{},[41,78,79],{},[44,80,46],{},[41,82,83],{},[44,84,85],{},"\u002Fv1\u002Fcheck\u002Fbulk",[41,87,88],{},"Check up to 1,000 addresses",[41,90,91],{},"1 per address answered",[20,93,94,98,103,106],{},[41,95,96],{},[44,97,46],{},[41,99,100],{},[44,101,102],{},"\u002Fv1\u002Ffeedback",[41,104,105],{},"Report what happened to a checked address",[41,107,108],{},"Free",[20,110,111,115,120,123],{},[41,112,113],{},[44,114,64],{},[41,116,117],{},[44,118,119],{},"\u002Fv1\u002Fmodel",[41,121,122],{},"Live accuracy of the model",[41,124,108],{},[126,127,129],"h2",{"id":128},"post-v1check",[44,130,131],{},"POST \u002Fv1\u002Fcheck",[14,133,134,150],{},[17,135,136],{},[20,137,138,141,144,147],{},[23,139,140],{},"Field",[23,142,143],{},"Type",[23,145,146],{},"Required",[23,148,149],{},"Description",[36,151,152,168,183],{},[20,153,154,159,162,165],{},[41,155,156],{},[44,157,158],{},"email",[41,160,161],{},"string",[41,163,164],{},"Yes",[41,166,167],{},"The address to check. Max 254 characters.",[20,169,170,175,177,180],{},[41,171,172],{},[44,173,174],{},"ip",[41,176,161],{},[41,178,179],{},"No",[41,181,182],{},"The user's public IP (IPv4 or IPv6). Adds cloud-server, Tor and same-IP checks. Never stored.",[20,184,185,190,193,195],{},[41,186,187],{},[44,188,189],{},"explain",[41,191,192],{},"boolean",[41,194,179],{},[41,196,197,200,201,204],{},[44,198,199],{},"true"," adds an ",[44,202,203],{},"evidence"," list showing how each signal moved the score.",[206,207,208,209,211,212,214,215,217],"p",{},"Prefer ",[44,210,46],{}," over ",[44,213,64],{},": addresses then stay out of URLs and server logs. The ",[44,216,64],{}," version takes the same fields as query parameters.",[126,219,221],{"id":220},"post-v1checkbulk",[44,222,223],{},"POST \u002Fv1\u002Fcheck\u002Fbulk",[225,226,231],"pre",{"className":227,"code":228,"language":229,"meta":230,"style":230},"language-json shiki shiki-themes signupsieve","{ \"emails\": [\"a.lee@gmail.com\", \"not-an-email\", \"test@mailinator.com\"] }\n","json","",[44,232,233],{"__ignoreMap":230},[234,235,238,242,246,249,253,256,259,261,264],"span",{"class":236,"line":237},"line",1,[234,239,241],{"class":240},"sp0VP","{ ",[234,243,245],{"class":244},"sZvsG","\"emails\"",[234,247,248],{"class":240},": [",[234,250,252],{"class":251},"sG-eq","\"a.lee@gmail.com\"",[234,254,255],{"class":240},", ",[234,257,258],{"class":251},"\"not-an-email\"",[234,260,255],{"class":240},[234,262,263],{"class":251},"\"test@mailinator.com\"",[234,265,266],{"class":240},"] }\n",[206,268,269,270,274],{},"Returns one entry per input, ",[271,272,273],"strong",{},"in the same order",". An invalid input returns an error entry instead of failing the whole request:",[225,276,278],{"className":227,"code":277,"language":229,"meta":230,"style":230},"{\n  \"results\": [\n    { \"email\": \"a.lee@gmail.com\", \"human_score\": 94, \"verdict\": \"allow\", \"...\": \"...\" },\n    { \"input\": \"not-an-email\", \"error\": \"not a valid email address\" },\n    { \"email\": \"test@mailinator.com\", \"human_score\": 0, \"verdict\": \"block\", \"...\": \"...\" }\n  ]\n}\n",[44,279,280,285,294,341,365,405,411],{"__ignoreMap":230},[234,281,282],{"class":236,"line":237},[234,283,284],{"class":240},"{\n",[234,286,288,291],{"class":236,"line":287},2,[234,289,290],{"class":244},"  \"results\"",[234,292,293],{"class":240},": [\n",[234,295,297,300,303,306,308,310,313,315,319,321,324,326,329,331,334,336,338],{"class":236,"line":296},3,[234,298,299],{"class":240},"    { ",[234,301,302],{"class":244},"\"email\"",[234,304,305],{"class":240},": ",[234,307,252],{"class":251},[234,309,255],{"class":240},[234,311,312],{"class":244},"\"human_score\"",[234,314,305],{"class":240},[234,316,318],{"class":317},"shnHK","94",[234,320,255],{"class":240},[234,322,323],{"class":244},"\"verdict\"",[234,325,305],{"class":240},[234,327,328],{"class":251},"\"allow\"",[234,330,255],{"class":240},[234,332,333],{"class":244},"\"...\"",[234,335,305],{"class":240},[234,337,333],{"class":251},[234,339,340],{"class":240}," },\n",[234,342,344,346,349,351,353,355,358,360,363],{"class":236,"line":343},4,[234,345,299],{"class":240},[234,347,348],{"class":244},"\"input\"",[234,350,305],{"class":240},[234,352,258],{"class":251},[234,354,255],{"class":240},[234,356,357],{"class":244},"\"error\"",[234,359,305],{"class":240},[234,361,362],{"class":251},"\"not a valid email address\"",[234,364,340],{"class":240},[234,366,368,370,372,374,376,378,380,382,385,387,389,391,394,396,398,400,402],{"class":236,"line":367},5,[234,369,299],{"class":240},[234,371,302],{"class":244},[234,373,305],{"class":240},[234,375,263],{"class":251},[234,377,255],{"class":240},[234,379,312],{"class":244},[234,381,305],{"class":240},[234,383,384],{"class":317},"0",[234,386,255],{"class":240},[234,388,323],{"class":244},[234,390,305],{"class":240},[234,392,393],{"class":251},"\"block\"",[234,395,255],{"class":240},[234,397,333],{"class":244},[234,399,305],{"class":240},[234,401,333],{"class":251},[234,403,404],{"class":240}," }\n",[234,406,408],{"class":236,"line":407},6,[234,409,410],{"class":240},"  ]\n",[234,412,414],{"class":236,"line":413},7,[234,415,416],{"class":240},"}\n",[206,418,419],{},"Addresses are checked in parallel, and addresses at the same domain share one lookup, so a bulk call is much faster than many single calls.",[126,421,423],{"id":422},"post-v1feedback",[44,424,425],{},"POST \u002Fv1\u002Ffeedback",[225,427,429],{"className":227,"code":428,"language":229,"meta":230,"style":230},"{ \"check_id\": \"chk_AXDmekmC35NL1mpGtCtC...\", \"outcome\": \"fake\" }\n",[44,430,431],{"__ignoreMap":230},[234,432,433,435,438,440,443,445,448,450,453],{"class":236,"line":237},[234,434,241],{"class":240},[234,436,437],{"class":244},"\"check_id\"",[234,439,305],{"class":240},[234,441,442],{"class":251},"\"chk_AXDmekmC35NL1mpGtCtC...\"",[234,444,255],{"class":240},[234,446,447],{"class":244},"\"outcome\"",[234,449,305],{"class":240},[234,451,452],{"class":251},"\"fake\"",[234,454,404],{"class":240},[206,456,457,458,461],{},"Or skip the ",[44,459,460],{},"check_id"," and send the address. It labels your latest check of that inbox:",[225,463,465],{"className":227,"code":464,"language":229,"meta":230,"style":230},"{ \"email\": \"maria.santos@gmail.com\", \"outcome\": \"confirmed\" }\n",[44,466,467],{"__ignoreMap":230},[234,468,469,471,473,475,478,480,482,484,487],{"class":236,"line":237},[234,470,241],{"class":240},[234,472,302],{"class":244},[234,474,305],{"class":240},[234,476,477],{"class":251},"\"maria.santos@gmail.com\"",[234,479,255],{"class":240},[234,481,447],{"class":244},[234,483,305],{"class":240},[234,485,486],{"class":251},"\"confirmed\"",[234,488,404],{"class":240},[206,490,491,492,495,496,501],{},"Returns ",[44,493,494],{},"202 Accepted",". See ",[497,498,500],"a",{"href":499},"\u002Fdocs\u002Ffeedback","Teach the model with feedback",".",[126,503,505],{"id":504},"get-v1model",[44,506,507],{},"GET \u002Fv1\u002Fmodel",[206,509,510],{},"Shows how accurate the model is, measured on real feedback before the model learned from each example. Example response (your numbers will differ):",[225,512,514],{"className":227,"code":513,"language":229,"meta":230,"style":230},"{\n  \"mode\": \"auto\",\n  \"serving\": \"baseline\",\n  \"healthy\": false,\n  \"learned_version\": 12,\n  \"feedback_examples\": 140,\n  \"customers\": 3,\n  \"baseline\": { \"accuracy\": 0.91, \"log_loss\": 0.27, \"recent_log_loss\": 0.25 },\n  \"learned\":  { \"accuracy\": 0.93, \"log_loss\": 0.22, \"recent_log_loss\": 0.21 },\n  \"recommendation\": \"keep collecting feedback\"\n}\n",[44,515,516,520,533,545,557,569,581,593,632,668,679],{"__ignoreMap":230},[234,517,518],{"class":236,"line":237},[234,519,284],{"class":240},[234,521,522,525,527,530],{"class":236,"line":287},[234,523,524],{"class":244},"  \"mode\"",[234,526,305],{"class":240},[234,528,529],{"class":251},"\"auto\"",[234,531,532],{"class":240},",\n",[234,534,535,538,540,543],{"class":236,"line":296},[234,536,537],{"class":244},"  \"serving\"",[234,539,305],{"class":240},[234,541,542],{"class":251},"\"baseline\"",[234,544,532],{"class":240},[234,546,547,550,552,555],{"class":236,"line":343},[234,548,549],{"class":244},"  \"healthy\"",[234,551,305],{"class":240},[234,553,554],{"class":317},"false",[234,556,532],{"class":240},[234,558,559,562,564,567],{"class":236,"line":367},[234,560,561],{"class":244},"  \"learned_version\"",[234,563,305],{"class":240},[234,565,566],{"class":317},"12",[234,568,532],{"class":240},[234,570,571,574,576,579],{"class":236,"line":407},[234,572,573],{"class":244},"  \"feedback_examples\"",[234,575,305],{"class":240},[234,577,578],{"class":317},"140",[234,580,532],{"class":240},[234,582,583,586,588,591],{"class":236,"line":413},[234,584,585],{"class":244},"  \"customers\"",[234,587,305],{"class":240},[234,589,590],{"class":317},"3",[234,592,532],{"class":240},[234,594,596,599,602,605,607,610,612,615,617,620,622,625,627,630],{"class":236,"line":595},8,[234,597,598],{"class":244},"  \"baseline\"",[234,600,601],{"class":240},": { ",[234,603,604],{"class":244},"\"accuracy\"",[234,606,305],{"class":240},[234,608,609],{"class":317},"0.91",[234,611,255],{"class":240},[234,613,614],{"class":244},"\"log_loss\"",[234,616,305],{"class":240},[234,618,619],{"class":317},"0.27",[234,621,255],{"class":240},[234,623,624],{"class":244},"\"recent_log_loss\"",[234,626,305],{"class":240},[234,628,629],{"class":317},"0.25",[234,631,340],{"class":240},[234,633,635,638,641,643,645,648,650,652,654,657,659,661,663,666],{"class":236,"line":634},9,[234,636,637],{"class":244},"  \"learned\"",[234,639,640],{"class":240},":  { ",[234,642,604],{"class":244},[234,644,305],{"class":240},[234,646,647],{"class":317},"0.93",[234,649,255],{"class":240},[234,651,614],{"class":244},[234,653,305],{"class":240},[234,655,656],{"class":317},"0.22",[234,658,255],{"class":240},[234,660,624],{"class":244},[234,662,305],{"class":240},[234,664,665],{"class":317},"0.21",[234,667,340],{"class":240},[234,669,671,674,676],{"class":236,"line":670},10,[234,672,673],{"class":244},"  \"recommendation\"",[234,675,305],{"class":240},[234,677,678],{"class":251},"\"keep collecting feedback\"\n",[234,680,682],{"class":236,"line":681},11,[234,683,416],{"class":240},[685,686,687],"style",{},"html pre.shiki code .sp0VP, html code.shiki .sp0VP{--shiki-default:#E2E8F0}html pre.shiki code .sZvsG, html code.shiki .sZvsG{--shiki-default:#BAE6FD}html pre.shiki code .sG-eq, html code.shiki .sG-eq{--shiki-default:#2EE59D}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html pre.shiki code .shnHK, html code.shiki .shnHK{--shiki-default:#FDE68A}",{"title":230,"searchDepth":287,"depth":287,"links":689},[690,691,692,693],{"id":128,"depth":287,"text":131},{"id":220,"depth":287,"text":223},{"id":422,"depth":287,"text":425},{"id":504,"depth":287,"text":507},"All SignupSieve API endpoints with request and response examples: single check, bulk check, feedback and model stats.","md",{},true,"\u002Fdocs\u002Fendpoints",{"title":5,"description":694},"docs\u002F3.endpoints","rgHeFkwmcEBWVLWqSjGo-P4SjxNmzPoecc6d4IIdeIY",[703,707,711,712,716,720,723,727],{"path":704,"title":705,"stem":706},"\u002Fdocs","Quick Start","docs\u002F1.index",{"path":708,"title":709,"stem":710},"\u002Fdocs\u002Fverdicts","Verdicts","docs\u002F2.verdicts",{"path":698,"title":5,"stem":700},{"path":713,"title":714,"stem":715},"\u002Fdocs\u002Fresponse-fields","Response Fields","docs\u002F4.response-fields",{"path":717,"title":718,"stem":719},"\u002Fdocs\u002Freason-codes","Reason Codes","docs\u002F5.reason-codes",{"path":499,"title":721,"stem":722},"Feedback","docs\u002F6.feedback",{"path":724,"title":725,"stem":726},"\u002Fdocs\u002Ferrors","Errors and Billing","docs\u002F7.errors",{"path":728,"title":729,"stem":730},"\u002Fdocs\u002Fexamples","Code Examples","docs\u002F8.examples",1792516808040]