메인 콘텐츠로 건너뛰기
POST
cURL
백엔드에서 애플리케이션 API 키를 사용해 gov.br 인증을 시작합니다. 워크플로나 workflow_id는 필요하지 않습니다. 시작 응답은 다음 인증 작업을 설명하며, 승인된 신원 확인 결과가 아닙니다.

적용 범위 및 활성화

지갑 활성화는 API 배포 및 애플리케이션의 자격 요건과 별개입니다. 문서화된 endpoint가 있더라도 출시 예정으로 표시된 지갑이 활성화되지는 않습니다. 현재 게시된 요금은 디지털 ID 지갑 요금을 참조하십시오.

사용자가 하는 일

시작 요청에서 반환된 다음 작업을 따릅니다. 지갑의 인증 방식에 따라 사용자가 브라우저, 다른 기기 또는 앱 중 무엇을 사용할지가 결정됩니다.

결과 받기

인증 상태를 추적하고 결과를 조회하려면 디지털 ID 지갑 API 가이드를 따르십시오. 완료되고 검증된 결과만 지갑이 사용자를 인증했다는 증거로 간주하십시오. 반환되는 신원 속성은 지갑마다 다릅니다. 주소, 얼굴 사진 또는 요청한 모든 속성이 포함된다고 가정하지 마십시오.

관련 문서

인증

x-api-key
string
header
필수

Business Console의 Developers -> API keys에서 발급받은 귀하 애플리케이션의 API 키입니다. 기본 키는 전체 접근 권한을 갖습니다. 이름이 지정된 키는 리소스별 none, read, write 범위로 권한을 제한할 수 있으며 특정 워크플로나 승인된 세션, IP 주소 목록, 만료일 등으로 제한할 수도 있습니다. 401은 키가 잘못되었거나 폐기되었거나 만료되었음을 의미합니다. 403은 키가 전송되지 않았거나, 키에 해당 리소스나 작업에 대한 접근 권한이 없거나, 요청이 허용된 IP 목록 외부 주소에서 발생했음을 의미합니다. 세션 경로에서의 404는 해당 세션이 키의 허용 워크플로 또는 상태 범위를 벗어났음을 의미합니다. 미디어 접근 권한이 없는 키는 이미지, 비디오, PDF URL을 null로 수신하며, 세션 write 권한이 없는 키는 세션 링크와 token을 null로 수신합니다. https://docs.didit.me/console/api-keys 를 참고하십시오.

헤더

Idempotency-Key
string

선택적 재시도 안전 키(최대 255자)입니다. 동일한 키, 지갑 및 본문으로 재시도하면 두 번째 로그인을 시작하지 않고 기존 인증을 반환합니다. 동일한 키를 다른 지갑이나 본문과 함께 사용하면 409 idempotency_key_reused를 반환합니다.

본문

gov.br 인증(BRA)을 시작합니다.

return_url
string<uri>
필수

지갑 완료 후 사용자의 브라우저가 돌아갈 https URL이며, request_id 및 result가 추가됩니다. 호스트는 애플리케이션의 allowed_return_hosts에 등록되어 있어야 합니다(또는 해당 화이트 라벨 도메인이어야 함). result 값만 단독으로 신뢰하지 마세요. GET .../verifications/{request_id}/ 또는 webhook을 통해 최종 결과를 확인하세요.

Required string length: 1 - 2048
vendor_data
string | null

이 인증에 대한 귀하 고유의 참조값(예: 사용자 ID)입니다. 결과 및 webhook으로 반환됩니다.

metadata
object | null

인증 건과 함께 저장되고 결과 및 webhook에 반환되는 선택적 JSON 객체입니다.

sandbox_scenario
string

샌드박스 애플리케이션 전용: 시뮬레이션된 결과 - 'wallet_cancelled', 'wallet_timeout' 또는 'wallet_provider_error'. 다른 시나리오(또는 시나리오를 지정하지 않은 경우)는 검증에 성공합니다. 프로덕션 애플리케이션에서는 거부됩니다. 전체 카탈로그는 GET /v1/sandbox/scenarios/에서 확인할 수 있습니다.

Minimum string length: 1
country
enum<string>
기본값:BRA

gov.br 신원의 ISO 3166-1 alpha-3 국가입니다. 기본값은 지원하는 유일한 국가인 BRA입니다.

  • BRA - BRA
사용 가능한 옵션:
BRA
device
enum<string>
기본값:same_device

페이지가 표시된 동일한 기기에서 로그인하는 경우 same_device, 다른 기기를 사용하는 경우 cross_device(예: BankID의 QR 코드)입니다.

  • same_device - same_device
  • cross_device - cross_device
사용 가능한 옵션:
same_device,
cross_device

응답

모든 지갑 endpoint가 응답하는 단일 독립형 지갑 검증입니다.

request_id
string<uuid>
필수
wallet_verification
object
필수
vendor_data
string | null
필수
metadata
object | null
필수

시작 시 전송된 메타데이터 객체 또는 null입니다.

created_at
string<date-time>
필수
마지막 수정일 2026년 11월 7일