계약서를 넣으면, 서명되어 나옵니다.

전체 구성

템플릿

PDF(또는 Word 파일)를 업로드하고 필드를 배치하거나, 문서 모드에서 계약서를 작성합니다. 변수는 JSON Schema로 정의되므로 API가 무엇이든 보내기 전에 데이터를 검증합니다. 게시된 버전은 변경할 수 없습니다.

봉투

POST /v1/envelopes 한 번으로 변수를 넣어 템플릿을 렌더링하고, 역할과 순서에 따라 수신자에게 라우팅을 시작합니다. 드라이 런, 멱등성 키, externalId 기반 중복 제거가 기본으로 제공됩니다.

원하는 방식으로 서명

이메일 링크, 호스팅 페이지, 또는 자사 앱 안의 <bf-signing> 웹 컴포넌트(React 및 Vue 래퍼 제공)를 사용할 수 있으며, 세션은 백엔드에서 발급하는 단기 일회용 세션입니다.

누구나 확인할 수 있는 증거

완료된 모든 문서에는 공개 타임스탬프 기관의 PAdES 문서 타임스탬프가 적용되고, 문서의 지문은 Merkle 트리에 추가되며 Bona Fide가 그 루트에 Ed25519로 서명합니다. 계정 없이도 누구나 사본을 검증할 수 있습니다.

한눈에 보는 수명 주기

1. 설계: 대시보드나 API에서 템플릿을 설계한 다음 버전을 게시합니다.
2. 발송: 템플릿 ID, 변수, 역할별 수신자 한 명을 지정해 POST /v1/envelopes로 봉투를 보냅니다.
3. 서명: 수신자는 이메일 링크를 받습니다. 또는 서명 세션을 발급해 임베드합니다(delivery: "embedded").
4. 완료: 마지막 수신자가 서명하면 입력된 모든 값이 담긴 envelope.completed 웹훅을 받습니다.
5. 봉인: envelope.sealed가 도착하면 봉인된 PDF(완료 인증서 포함)가 준비된 것입니다.
6. 검증: 누구나 검증 페이지에 PDF를 끌어다 놓거나 공개 검증 API를 호출할 수 있습니다.

API가 편리한 이유

• 바로 조치할 수 있는 오류. 모든 오류는 RFC 9457 problem+json 형식이며, 검증 오류에는 문제마다 /variables/client/email 같은 JSON Pointer가 포함됩니다.
• 안전한 재시도. POST 요청에 Idempotency-Key를 보내면 재시도 시 첫 번째 응답이 그대로 재생됩니다.
• 무료 무제한 테스트 모드. bf_test_ 키로 만든 봉투에는 워터마크가 들어가며 요금이 청구되지 않습니다. 인증을 참조하세요.
• 표준을 따르는 웹훅. 전송은 Standard Webhooks에 따라 서명되고, 3일 동안 재시도되며, 다시 보낼 수도 있습니다.
• 코드에서 생성되는 OpenAPI 3.1. 레퍼런스와 다운로드할 수 있는 openapi.json / openapi.yaml은 API가 검증에 사용하는 것과 동일한 zod 계약으로 빌드됩니다.

다음 단계

빠른 시작API 키, 템플릿으로 봉투 만들기, 서명, 완료 웹훅까지 10분 만에.

개념템플릿, 역할, 필드, 봉투, 수신자, 세션, 조직.

임베드 서명으로 서명 경험을 자사 제품 안에 넣으세요.

검증봉인과 앵커링의 작동 방식, 그리고 문서를 직접 확인하는 방법.

API의 기본 주소는 https://api.bonafidesign.com입니다. 이 문서의 모든 경로는 이 주소를 기준으로 한 상대 경로입니다.