메인 콘텐츠로 건너뛰기

프로세스 생성

MarkdownChatGPTClaude

이것은 모든 Unico API 통합의 진입점입니다. 백엔드가 이를 호출하여 프로세스를 생성하고, 프론트엔드는 반환된 토큰을 사용하여 iFrame을 렌더링하거나 사용자를 리디렉션하거나 네이티브 SDK를 초기화합니다.

전체 통합 플로우는 플로우를 참조하세요.

Endpoint​

환경URL
프로덕션POST https://api.idcloud.unico.app/client/v1/process
샌드박스POST https://api.idcloud.uat.unico.app/client/v1/process

요청​

헤더
헤더값
AuthorizationBearer <access_token>(인증 참조)
Content-Typeapplication/json
본문 매개변수
필드 요구사항은 flow에 따라 다릅니다

필드가 필수인지, 선택인지, 해당되지 않는지는 통합하는 flow에 따라 다릅니다 — 이 표만으로 필드의 요구사항을 단정하기 전에, 사용 중인 특정 레시피에 대해 플로우를 확인하세요.

필드유형설명
callbackUristring여정이 끝난 후 사용자가 리디렉션되는 URL입니다. 콜백이 앱 내부에서 처리되는 네이티브 SDK flow의 경우 /를 사용하세요.
flowstringflow 식별자입니다 — 실행될 기능을 결정합니다. 예: idunicodocs, idunicosign, idchecktrust, idtoken, idsmart. 사용 가능한 플로우를 참조하세요.
purposestring비즈니스 목적입니다. 허용되는 값: creditprocess, biometryonboarding, carpurchase, ageverification.
person.duiTypeenum문서 유형입니다. 아래의 duiType 값을 참조하세요.
person.duiValuestring형식 없는 문서 번호입니다.
person.friendlyNamestring여정 UI에 표시되는 사용자의 표시 이름입니다. 최대 50자.
person.phonestring구분자 없는 DDI + DDD + 번호 형식의 전화번호입니다. SMS 또는 WhatsApp으로 알림을 보낼 때 필수입니다.
person.emailstring이메일 주소입니다. 전자서명이 포함된 flow에서는 필수입니다.
person.​notificationsarray여정 링크를 전송할 알림 채널입니다. 각 항목은 NOTIFICATION_CHANNEL_WHATSAPP, NOTIFICATION_CHANNEL_SMS, 또는 NOTIFICATION_CHANNEL_EMAIL 값을 가진 notificationChannel을 포함합니다.
referencesarray1:1 검증 및 스마트 재검증 flow를 위한 참조 입력입니다. 각 항목은 referenceType(REFERENCE_TYPE_IMAGE_BASE64 또는 REFERENCE_TYPE_PROCESS_ID)과 referenceContent(base64로 인코딩된 이미지 또는 프로세스 UUID)를 포함합니다. 항목은 최대 1개까지만 전송하세요 — 더 긴 배열은 400으로 거부되며, referenceContent는 비어 있으면 안 됩니다.
useCasestring스마트 재검증 시나리오입니다. 🇧🇷 idsmart, idsmart_r2, idsmart_tp1에서 필수입니다. 예: USE_CASE_LOGIN, USE_CASE_FIN_TRANSACTIONS.
clientReferencestring귀사 시스템 내 사용자의 고유 식별자입니다. 다중 계정 기능에는 필수입니다. 귀사 기준으로 고유해야 하며, 최대 256자, 공백 없음.
companyBranchIdstring (UUID)지점 ID입니다. 서비스 계정에 연결된 지점이 두 개 이상인 경우에만 필수입니다.
expiresInstring생성 시점부터의 프로세스 유효 기간입니다. 형식: "3600s". 생략하면 기본값은 7일입니다.
flowConfigobjectflow별 설정 오버라이드입니다.
flowConfig.​biometryCapture.​enabledBackCameraboolean기기의 후면 카메라를 사용합니다. 문서 캡처 또는 전자서명 flow와는 호환되지 않습니다.
contextualizationobject캡처를 설명하기 위해 여정 중 사용자에게 표시되는 거래 컨텍스트입니다. 특정 국가에 국한되지 않고 모든 지역의 고객이 사용할 수 있습니다.
contextualization.​company_namestring여정 중 표시되는 회사 이름입니다. 최대 20자.
contextualization.​currencystring사용자에게 표시되는 통화 코드입니다. 허용되는 값: BRL, MXN, USD.
contextualization.​pricenumber사용자에게 표시되는 거래 금액입니다.
contextualization.​localeobject여정 중 표시되는 현지화된 텍스트입니다. 키: ptBr, enUs, esMx — 고객의 지역과 관계없이 텍스트에 지원되는 언어는 이것뿐입니다.
contextualization.locale.{ptBr|enUs|esMx}.reasonstring여정 중 표시되는 캡처에 대한 짧은 이유입니다. 최대 50자.
contextualization.locale.{ptBr|enUs|esMx}.titlestring여정 중 표시되는 고객 안내문의 제목입니다. 최대 100자. text와 함께 제공해야 합니다. HTML 태그는 제거됩니다.
contextualization.locale.{ptBr|enUs|esMx}.textstring여정 중 표시되는 고객 안내문의 본문입니다. 최대 210자. title과 함께 제공해야 합니다. HTML 태그는 제거됩니다.
imageBase64string직접 전송되는 셀피입니다. SDK의 캡처 JWT를 받습니다.
document.purposeenum문서의 용도입니다. 고정된 값: DOCUMENT_PURPOSE_ONBOARDING, DOCUMENT_PURPOSE_CREDIT_PROCESS, DOCUMENT_PURPOSE_CAR_PURCHASE, DOCUMENT_PURPOSE_PAY_BY_PAYCHECK, DOCUMENT_PURPOSE_FGTS. Face Document Match flow에서만 사용됩니다.
document.​files[].​databytes새로운 문서 캡처로, base64로 인코딩됩니다. 브라질에 국한되지 않고 전 세계적으로 사용 가능합니다. document.documentId와는 상호 배타적입니다.
document.documentIdstring (UUID)새로운 캡처 대신 동일한 사용자가 이미 캡처한 문서를 재사용합니다. document.files[]와는 상호 배타적입니다.
expectedResultobject테스트/샌드박스 환경에서 기능의 결과를 모의(mock)하고 응답에 simulated: true를 표시합니다. 결과 시뮬레이션(Test Mock)을 참조하세요.
duiType 값
국가값설명
ARDUI_TYPE_AR_PASSPORT아르헨티나 여권
ARDUI_TYPE_AR_DNI아르헨티나 DNI
ARDUI_TYPE_AR_LNC아르헨티나 운전면허증(Licencia Nacional de Conducir)
ATDUI_TYPE_AT_STNR오스트리아 납세자 번호(STNR)
BEDUI_TYPE_BE_NN벨기에 국민 번호(NN)
BRDUI_TYPE_BR_CPF브라질 CPF
BRDUI_TYPE_BR_PASSPORT브라질 여권
BRDUI_TYPE_BR_CNPJ브라질 CNPJ
CADUI_TYPE_CA_SIN캐나다 SIN
CHDUI_TYPE_CH_AHV스위스 AHV/AVS 번호
CLDUI_TYPE_CL_RUN칠레 RUN
CLDUI_TYPE_CL_PASSPORT칠레 여권
CLDUI_TYPE_CL_LICENCIA_CONDUCIR칠레 운전면허증(Licencia de Conducir)
CODUI_TYPE_CO_NIT콜롬비아 NIT
CODUI_TYPE_CO_PASSPORT콜롬비아 여권
CODUI_TYPE_CO_LICENCIA_CONDUCCION콜롬비아 운전면허증(Licencia de Conducción)
CODUI_TYPE_CO_CC콜롬비아 시민증(Cédula de Ciudadanía)
DEDUI_TYPE_DE_IDNR독일 세무 식별 번호(IdNr)
DKDUI_TYPE_DK_CPR덴마크 CPR
ECDUI_TYPE_EC_NI에콰도르 NI
ESDUI_TYPE_ES_NIE스페인 외국인 식별 번호(NIE)
ESDUI_TYPE_ES_DNI스페인 국민 신분증(DNI)
FIDUI_TYPE_FI_HETU핀란드 개인 식별 번호(HETU)
FRDUI_TYPE_FR_SPI프랑스 세무 참조 번호(SPI)
GBDUI_TYPE_GB_NINO영국 국민보험번호(NINO)
GTDUI_TYPE_GT_CUI과테말라 CUI
IDDUI_TYPE_ID_NIK인도네시아 NIK
IEDUI_TYPE_IE_PPSN아일랜드 개인 공공 서비스 번호(PPSN)
ITDUI_TYPE_IT_CF이탈리아 세무 번호(CF)
LKDUI_TYPE_LK_NIC스리랑카 NIC
LUDUI_TYPE_LU_MATRICULE룩셈부르크 국민 식별 번호(Matricule)
MXDUI_TYPE_MX_CURP멕시코 CURP
MXDUI_TYPE_MX_RFC_PERSONA_FISICA멕시코 RFC(개인)
MXDUI_TYPE_MX_LICENCIA_CONDUCIR멕시코 운전면허증(Licencia de Conducir)
NGDUI_TYPE_NG_NIN나이지리아 NIN
NGDUI_TYPE_NG_BVN나이지리아 은행 인증 번호(BVN)
NGDUI_TYPE_NG_BVN_TOKEN나이지리아 BVN 토큰(해시)
NGDUI_TYPE_NG_NIN_TOKEN나이지리아 NIN 토큰(해시)
NLDUI_TYPE_NL_BSN네덜란드 시민 서비스 번호(BSN)
NODUI_TYPE_NO_FNR노르웨이 국민 식별 번호(Fødselsnummer)
PEDUI_TYPE_PE_RUC페루 RUC
PEDUI_TYPE_PE_DNI페루 DNI
PEDUI_TYPE_PE_PASSPORT페루 여권
PLDUI_TYPE_PL_PESEL폴란드 PESEL
PTDUI_TYPE_PT_NIF포르투갈 납세자 번호(NIF)
SEDUI_TYPE_SE_PNR스웨덴 개인번호(PNR)
SEDUI_TYPE_SE_SAMORDNINGSNUMMER스웨덴 조정 번호(Samordningsnummer)
TRDUI_TYPE_TR_TCKN튀르키예 국민 식별 번호(TCKN)
USDUI_TYPE_US_SSN미국 SSN
USDUI_TYPE_US_PASSPORT미국 여권
USDUI_TYPE_US_DRIVER_LICENSE미국 운전면허증
USDUI_TYPE_US_PASSPORT_CARD미국 여권 카드
USDUI_TYPE_US_POLYCARBONATE_PASSPORT미국 폴리카보네이트 여권
USDUI_TYPE_US_ID_CARD미국 ID 카드
UYDUI_TYPE_UY_CI우루과이 CI
ZZDUI_TYPE_ZZ_EMAIL이메일 주소
ZZDUI_TYPE_ZZ_PHONE_NUMBER전화번호
문서 없이 프로세스 생성하기

flow가 선택적 문서를 허용하는 경우 person.duiType과 person.duiValue를 생략할 수 있습니다. 캡처 후 프로세스는 백엔드가 프로세스 문서 설정으로 문서를 전송할 때까지 AWAITING_FOR_DOCUMENT 상태로 대기합니다.

예제​

curl -X POST https://api.idcloud.unico.app/client/v1/process \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"flow": "idunicodocs_r2",
"purpose": "biometryonboarding",
"clientReference": "pedido-88216",
"callbackUri": "https://your-app.example.com/onboarding/callback",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678909"
}
}'

응답​

200 OK
{
"process": {
"id": "b7c1f0a2-63d4-4f3e-9a17-2c8e5d41b0aa",
"flow": "idunicodocs_r2",
"state": "PROCESS_STATE_CREATED",
"result": "PROCESS_RESULT_UNSPECIFIED",
"purpose": "biometryonboarding",
"clientReference": "pedido-88216",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678909"
},
"capacities": [
"PROCESS_CAPACITY_IDLIVE",
"PROCESS_CAPACITY_IDUNICO",
"PROCESS_CAPACITY_IDDOCS"
],
"authenticationInfo": {
"authenticationId": ""
},
"companyData": {
"branchId": "",
"countryCode": "BRA"
},
"callbackUri": "https://your-app.example.com/onboarding/callback",
"userRedirectUrl": "https://cadastro.unico.app/flow?id=b7c1f0a2-63d4-4f3e-9a17-2c8e5d41b0aa",
"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…",
"webAppToken": "eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0…",
"simulated": false
}
}
필드유형설명
process.idstring (UUID)프로세스 식별자입니다. 프로세스 조회를 통해 결과를 가져오는 데 사용하세요.
process.stateenumPROCESS_STATE_CREATED — 프로세스가 생성되었으며 여정이 아직 시작되지 않았습니다. PROCESS_STATE_FAILED — 프로세스 생성에 실패했습니다.
process.resultenum검증 결과입니다. state = PROCESS_STATE_FINISHED인 경우에만 존재합니다 — 특정 flow가 반환할 수 있는 결과 값은 플로우를 참조하세요.
process.flowstring생성 시 전송된 flow 식별자입니다.
process.purposestring생성 시 전송된 비즈니스 목적입니다.
process.callbackUristring생성 시 전송된 콜백 URI입니다.
process.​clientReferencestring생성 시 전송된 귀사의 내부 식별자입니다. 요청에 제공된 경우에만 존재합니다.
process.​companyBranchIdstring (UUID)지점 ID입니다. 요청에 제공된 경우에만 존재합니다.
process.​userRedirectUrlstring사용자를 리디렉션할 URL입니다(Web Redirect 및 iFrame 통합). 이 URL을 수정하지 마세요.
process.tokenstringWeb SDK iFrame을 초기화하기 위한 JWT입니다.
process.webAppTokenstring네이티브 SDK(Android, iOS, Flutter)를 초기화하기 위한 JWT입니다.
process.createdAtstring (date-time)프로세스가 생성된 시각의 타임스탬프입니다.
process.expiresAtstring (date-time)이 시각 이후 프로세스가 만료되어 더 이상 완료할 수 없게 되는 타임스탬프입니다.
process.capacitiesarray이 프로세스에 설정된 기능입니다.
process.​authenticationInfoobject프로세스의 인증 정보입니다(생성 시점에는 비어 있습니다).
process.personobject생성 시 전송된 person 객체의 에코입니다.
process.​companyData.​branchIdstring (UUID)프로세스와 연관된 지점 ID입니다.
process.​companyData.​countryCodestring지점과 연관된 국가 코드입니다(예: BR, MX).

오류 코드​

코드메시지설명
3invalid flow지정된 flow가 존재하지 않을 때.
3invalid person: friendly name exceeds 50 characters.표시 이름이 50자를 초과할 때.
3invalid purpose제공된 purpose가 유효하지 않을 때.
3invalid callbackUri: unable to parse callbackUri: parse "": empty url, invalid callbackUri: url:제공된 callbackUri가 유효하지 않을 때.
3invalid person: email required for notification channel NOTIFICATION_CHANNEL_EMAIL, invalid email address for notification channel NOTIFICATION_CHANNEL_EMAIL제공된 이메일이 유효하지 않고 이메일 알림이 설정되어 있을 때.
3invalid person: phone number required for notification channel NOTIFICATION_CHANNEL_WHATSAPP, phone number does not contain 13 chars for notification channel NOTIFICATION_CHANNEL_WHATSAPP제공된 전화번호가 유효하지 않고 SMS 또는 WhatsApp 알림이 설정되어 있을 때.
3idnsv2/GetPublicID request error: rpc error: code = InvalidArgument desc = invalid dui value제공된 식별자(duiValue)가 유효하지 않을 때.
3invalid expiresIn argumentexpiresIn 값이 유효하지 않을 때.
3invalid company_name argument in process contextualization, max length is 20contextualization.​company_name이 20자를 초과할 때.
3title and text must be provided together in process contextslocale에서 title 또는 text 중 하나만 제공될 때.
3invalid title argument in process contexts, max length is 100locale의 title이 100자를 초과할 때.
3invalid text argument in process contexts, max length is 210locale의 text가 210자를 초과할 때.
3invalid reason argument in process contexts, max length is 50locale의 reason이 50자를 초과할 때.
3The references array must contain at most one element.references에 항목이 두 개 이상 전송될 때.
3The references[].referenceContent field is missing.referenceContent가 비어 있을 때.
3The references[].referenceType field must be IMAGE_BASE64 or PROCESS_ID.referenceType이 지원되는 값 중 하나가 아닐 때.
3A reference is required for this flow.flow에서 참조가 필요하지만 전송되지 않았을 때. referenceType이 PROCESS_ID 또는 IMAGE_BASE64인 references[0]을 전송하세요.
9The referenceProcessId field is invalid.참조 프로세스가 존재하지 않거나 재사용할 수 없을 때. 전송한 필드명을 알려줍니다 — 해당 필드를 보냈다면 bioTokenId.
3INVALID_IMAGE이미지가 유효한 base64가 아니거나 인젝션 시도처럼 보일 때.
3INVALID_DUI문서 번호가 표준이 아니거나 존재하지 않을 때.
3IMAGE_TOO_LARGE이미지가 최대 크기인 800KB를 초과할 때.
3UNSUPPORTED_IMAGE_FORMAT이미지 형식이 PNG, JPEG, WebP가 아닐 때.
3MISSING_IMAGE이 flow에 이미지가 필수이지만 전송되지 않았을 때.
3MISSING_NAME이 flow에 이름이 필수이지만 전송되지 않았을 때.
3MISSING_DUI이 flow에 문서 번호가 필수이지만 전송되지 않았을 때.
3MISSING_PERSON이 flow에 person 객체가 필수이지만 전송되지 않았을 때.
3INVALID_REQUEST요청 본문이 null이거나 해석할 수 없을 때.
3TOKEN_ALREADY_USED캡처 토큰이 이미 사용되었을 때. 이 토큰은 1회용입니다.
3TOKEN_EXPIRED캡처 토큰이 만료되었을 때. 10분 이내에 사용해야 합니다.
3INVALID_BUNDLE요청이 보안 요구사항을 충족하지 않을 때.
3INVALID_NAME이름이 허용된 최대 길이를 초과할 때.
3INVALID_EMAIL이메일 주소의 형식이 잘못되었거나 너무 길 때.
3INVALID_PHONE전화번호가 20자를 초과할 때.
3INVALID_DUI_TYPE문서 유형이 지원되는 값 중 하나가 아닐 때.
3INVALID_CLIENT_REFERENCEclientReference가 너무 길거나 공백 또는 #을 포함할 때.
3INVALID_CONSENT_TYPEconsentType이 NONE, DIRECT, INDIRECT 중 하나가 아닐 때.
3INVALID_USE_CASEuseCase를 인식할 수 없거나 너무 길 때.
3INVALID_DEVICE_TRUST_TOKENdevice-trust 토큰이 유효하지 않거나 이미 사용되었을 때.
3TOO_MANY_REFERENCESreferences에 항목이 두 개 이상 전송될 때.
3INVALID_REFERENCE_TYPEreferenceType이 IMAGE_BASE64 또는 PROCESS_ID가 아닐 때.
3INVALID_REFERENCE_PROCESS참조 프로세스 ID가 유효한 식별자가 아닐 때.
3REFERENCE_PROCESS_NOT_FOUND참조된 프로세스가 존재하지 않을 때.
3REFERENCE_PROCESS_NOT_READY참조된 프로세스에 재사용 가능한 결과가 없거나 이미 사용되었을 때.
3REFERENCE_SELFIE_NOT_FOUND참조된 프로세스에 재사용할 셀피가 없을 때.
3INVALID_CAPTURE_TOKEN캡처된 이미지가 캡처 SDK에서 생성한 유효한 토큰이 아닐 때.
3INVALID_CAPTURE_SIGNATURE캡처 토큰의 서명이 검증되지 않을 때.
3PRIOR_CAPTURE_NOT_FOUND이 요청이 기반으로 하는 이전 캡처를 찾을 수 없을 때. 프로세스를 다시 시작하세요.
3PRIOR_CAPTURE_IN_PROGRESS이전 캡처가 아직 완료되지 않았을 때. 잠시 후 다시 시도하세요.
3PRIOR_CAPTURE_FAILED이전 캡처를 완료할 수 없었을 때. 프로세스를 다시 시작하세요.
3INVALID_DOCUMENT문서 파일을 읽을 수 없거나, 비밀번호로 보호되어 있거나, 지원되지 않는 형식일 때.
3INVALID_AUTH_PROCESSdocument.authProcessId가 유효하지 않거나, 만료되었거나, 다른 사람에게 속할 때.
3INVALID_DOCUMENT_PURPOSEdocument.purpose가 지원되는 값 중 하나가 아닐 때.
3PROCESS_REUSE_NOT_ENABLEDflow가 이미지 없이 이전 프로세스를 재사용하는 것을 허용하지 않을 때. 대신 이미지를 전송하세요.
9PROCESS_FAILED프로세스가 생성 중 종단 오류에 도달했을 때.
9Tenant API key is not configuredAPI Key가 올바르게 설정되지 않았을 때.

다음 단계​

  • 사용자가 여정을 완료한 후, 프로세스 조회를 호출하여 결과를 가져오거나 webhook을 기다리세요.
  • 모든 레시피 조합과 가능한 결과 값을 확인하려면 플로우를 참조하세요.
  • 실제 생체 인식 캡처 없이 결과를 테스트하려면 결과 시뮬레이션(Test Mock)을 참조하세요.