"use strict";(self.webpackChunkbaf=self.webpackChunkbaf||[]).push([[7257],{1645:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>o,contentTitle:()=>s,default:()=>c,frontMatter:()=>l,metadata:()=>r,toc:()=>p});var n=a(7896),i=(a(2784),a(876));const l={id:"api_baf_manual",title:"Manual operations",sidebar_label:"Manual operations"},s=void 0,r={unversionedId:"user_guide/api_baf_manual",id:"user_guide/api_baf_manual",title:"Manual operations",description:"This section of the API allows operations on the applicant to bypass the web component and various checks. For example, to upload a photo database or manually register an applicant.",source:"@site/docs/user_guide/api_baf_manual.md",sourceDirName:"user_guide",slug:"/user_guide/api_baf_manual",permalink:"/user_guide/api_baf_manual",draft:!1,tags:[],version:"current",frontMatter:{id:"api_baf_manual",title:"Manual operations",sidebar_label:"Manual operations"},sidebar:"docs",previous:{title:"Shared errors",permalink:"/user_guide/api_baf_shared_errors"},next:{title:"Access to API",permalink:"/user_guide/api_baf_access"}},o={},p=[{value:"Registration",id:"registration",level:3}],d={toc:p},u="wrapper";function c(t){let{components:e,...a}=t;return(0,i.kt)(u,(0,n.Z)({},d,a,{components:e,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"This section of the API allows operations on the applicant to bypass the web component and various checks. For example, to upload a photo database or manually register an applicant."),(0,i.kt)("h3",{id:"registration"},"Registration"),(0,i.kt)("p",null,"Manual registration of the applicant by photo. During registration, checks from the \u201cManual mode settings\u201d section of the settings will be performed."),(0,i.kt)("p",null,"Endpoint: POST /publicapi/api/v2/private/Manual/Register"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Request body:")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-cpp"},'{\n  "faceImageBase64": "string",\n  "applicantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"\n}\n')),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Request example:")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-cpp"},"curl -X 'POST' \\\n  'https://baf.ai/publicapi/api/v2/private/Manual/Register' \\\n  -H 'accept: application/json' \\\n  -H 'Content-Type: application/json-patch+json' \\\n  -d '{ \"faceImageBase64\": \"string\", \"applicantId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\" }'\n")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Response example:")),(0,i.kt)("table",null,(0,i.kt)("body",null,(0,i.kt)("tr",null,(0,i.kt)("td",{width:"400"},"Status Code"),(0,i.kt)("td",{width:"400"},"200")))),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Possible errors:")),(0,i.kt)("table",null,(0,i.kt)("tbody",null,(0,i.kt)("tr",null,(0,i.kt)("td",{class:"center-aligned",width:"400"},(0,i.kt)("b",null,"HTTP code")),(0,i.kt)("td",{class:"center-aligned",width:"400"},(0,i.kt)("b",null,"Message")),(0,i.kt)("td",{class:"center-aligned",width:"400"},(0,i.kt)("b",null,"Description")),(0,i.kt)("td",{class:"center-aligned",width:"400"},(0,i.kt)("b",null,"Error code"))),(0,i.kt)("tr",null,(0,i.kt)("td",{width:"400"},"400"),(0,i.kt)("td",{width:"400"},"Request is closed"),(0,i.kt)("td",{width:"400"},"Attempted registration by closed applicant"),(0,i.kt)("td",{width:"400"},"120040")),(0,i.kt)("tr",null,(0,i.kt)("td",{width:"400"},"400"),(0,i.kt)("td",{width:"400"},"Applicant is already registered"),(0,i.kt)("td",{width:"400"},"Attempted registration by registered applicant"),(0,i.kt)("td",{width:"400"},"150001")))))}c.isMDXComponent=!0}}]);