데이터 검증

엔드포인트

환경	URL
프로덕션	`POST https://api.idcloud.unico.app/lists/{cpf}`
샌드박스	`POST https://api.idcloud.uat.unico.app/lists/{cpf}`

설계상 별도의 엔드포인트

이 엔드포인트는 표준 프로세스 생성(POST /processes/v1)과는 별개입니다. 결정론적인 신원 확인 결과가 아니라 데이터 목록을 반환합니다.

요청

헤더

헤더	값
`Authorization`	`Bearer <access_token>` (참조: 인증)

경로 매개변수

매개변수	타입	필수	설명
`cpf`	string	예	조회할 사람의 CPF.

curl -X POST "https://api.idcloud.uat.unico.app/lists/12345678909" \
  -H "Authorization: Bearer $TOKEN"

응답

루트 엔벨로프

{
  "id": "41c24382-36ce-4bb4-8339-352114f71f78",
  "status": 3,
  "lists": { }
}

필드	타입	설명
`id`	string (UUID)	고유 요청 식별자.
`status`	integer	처리 상태.
`lists`	object	조회된 데이터를 포함하는 기본 페이로드.

`lists.basicData` — 등록 데이터

{
  "basicData": {
    "name": "JOAO DA SILVA",
    "birthCountry": "BRASILEIRA",
    "birthDate": "1990-01-01T00:00:00Z",
    "gender": "M",
    "motherName": "MARIA DA SILVA",
    "fatherName": "",
    "maritalStatus": "",
    "rgNumber": "",
    "rgIssuingAgency": "",
    "rgStateCode": "",
    "financialData": {
      "incomeEstimate": "...",
      "totalAssets": "..."
    },
    "address": {
      "addressMain": "AVENIDA DO ESTADO",
      "number": "123",
      "complement": "ANDAR 1",
      "neighborhood": "CENTRO",
      "zipCode": "12345678",
      "city": "SAO PAULO",
      "state": "SP",
      "country": "BRASIL",
      "type": "WORK"
    },
    "email": "...",
    "phone": "+554799999999",
    "socialName": ""
  }
}

필드	타입	설명
`name`	string	전체 이름.
`birthCountry`	string	출생 국가.
`birthDate`	string (ISO 8601)	생년월일.
`gender`	string	성별.
`motherName`	string	어머니 이름.
`fatherName`	string	아버지 이름.
`maritalStatus`	string	혼인 상태.
`rgNumber`	string	RG 번호.
`rgIssuingAgency`	string	RG 발급 기관.
`rgStateCode`	string	RG 발급 주(州) 코드.
`financialData.incomeEstimate`	string	소득 추정치.
`financialData.totalAssets`	string	총 자산.
`email`	string	이메일.
`phone`	string	전화번호.
`socialName`	string	소셜 네임(사회적 이름). 등록된 소셜 네임이 없는 경우 비어 있을 수 있습니다.

basicData.address:

필드	타입	설명
`addressMain`	string	도로명.
`number`	string	번지수(번호).
`complement`	string	상세 주소.
`neighborhood`	string	지역(동네).
`zipCode`	string	우편번호.
`city`	string	도시.
`state`	string	주(州) 코드.
`country`	string	국가.
`type`	string	주소 유형(예: `WORK`).

`lists.riskData.taxIdValidation` — CPF 검증

{
  "taxIdValidation": {
    "taxIdStatus": "REGULAR",
    "taxIdStatusDate": "...",
    "decease": false,
    "under18": false
  }
}

필드	타입	설명
`taxIdStatus`	string	CPF 등록 상태.
`taxIdStatusDate`	string	등록 상태 날짜.
`decease`	boolean	사망 여부를 나타냅니다.
`under18`	boolean	만 18세 미만 여부를 나타냅니다.

`lists.riskData.pep` — 정치적 주요인물(PEP)

{
  "pep": {
    "isCurrentlyPep": true,
    "records": [
      {
        "level": "1",
        "jobTitle": "SENADOR",
        "motive": "FEDERAL EMPLOYEE"
      }
    ]
  }
}

필드	타입	설명
`isCurrentlyPep`	boolean	현재 PEP 여부.
`records`	array	본인의 PEP 기록.
`records[].level`	string	정치적 노출 수준.
`records[].jobTitle`	string	직책.
`records[].motive`	string	분류 사유.

`lists.riskData.aml` — 자금세탁방지(제재)

{
  "aml": {
    "isSanctioned": true,
    "records": [
      {
        "type": "Law Enforcement",
        "source": "interpol",
        "standardizedType": "ARREST WARRANTS",
        "endDate": "..."
      }
    ]
  }
}

필드	타입	설명
`isSanctioned`	boolean	제재 대상 여부.
`records`	array	본인의 제재 기록.
`records[].type`	string	제재 유형.
`records[].source`	string	제재 출처.
`records[].standardizedType`	string	표준화된 유형.
`records[].endDate`	string	종료일.

`lists.riskData.sportsRelationship` — 스포츠 베팅 관련성

{
  "sportsRelationship": {
    "hasSportsRelationship": false,
    "isCurrentlyAthlete": false,
    "isCurrentlySportsCoach": false,
    "isCurrentlySportsClubDirector": false,
    "isCurrentlyReferee": false,
    "isCurrentlyRelatedToFinanceMinistry": false,
    "isCurrentlyBettingCompanyOwner": false,
    "sportsRelationshipMotive": "",
    "sportExposures": []
  }
}

필드	타입	설명
`hasSportsRelationship`	boolean	스포츠 관련성 여부.
`isCurrentlyAthlete`	boolean	현역 선수 여부.
`isCurrentlySportsCoach`	boolean	현역 코치 여부.
`isCurrentlySportsClubDirector`	boolean	현역 클럽 이사 여부.
`isCurrentlyReferee`	boolean	현역 심판 여부.
`isCurrentlyRelatedToFinanceMinistry`	boolean	재무부와의 관련성 여부.
`isCurrentlyBettingCompanyOwner`	boolean	베팅 회사 소유주 여부.
`sportsRelationshipMotive`	string	관련성 사유.
`sportExposures`	array	세부 스포츠 노출 정보.

sportExposures[]:

필드	타입	설명
`sportName`	string	스포츠 종목명.
`region`	string	활동 지역.
`totalRelatedEntities`	integer	관련 주체 총수.
`relationshipLevel`	string	관련성 수준.
`endDate`	string	종료일.

오류 코드

400 Bad Request
403 Forbidden
500 Internal Server Error

코드	메시지	설명
`99989`	The document is invalid.	CPF가 유효하지 않은 경우.

코드	메시지	설명
`10501`	The authorization token is invalid.	인증 토큰이 유효하지 않은 경우.

코드	메시지	설명
`99999`	Internal failure! Try again later	내부 오류가 발생한 경우.

엔드포인트​

요청​

응답​

오류 코드​

엔드포인트

요청

응답

오류 코드