curl -X PATCH 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"color_primary": "#123456", "font_family": "AR One Sans"}'{
"color_primary": "#123456",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 16,
"font_family": "AR One Sans",
"font_weight": "400",
"font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans",
"logo_square": null,
"logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": true,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}브랜딩 업데이트 API (화이트 라벨 커스터마이징)
Didit Management API로 화이트 라벨 브랜딩을 업데이트하세요. 색상, 글꼴, 테두리 반경을 변경하고 로고를 업로드하며 인증 흐름 UI 옵션을 조정할 수 있습니다.
curl -X PATCH 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"color_primary": "#123456", "font_family": "AR One Sans"}'{
"color_primary": "#123456",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 16,
"font_family": "AR One Sans",
"font_weight": "400",
"font_url": "https://fonts.googleapis.com/css2?family=AR+One+Sans",
"logo_square": null,
"logo_rectangular": "https://cdn.didit.me/white_label/logo_rectangular/...",
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": true,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}개요
API 키로 식별되는 애플리케이션의 화이트 라벨 브랜딩을 부분 업데이트합니다. 색상, 글꼴, 모서리 반경, UI 옵션을 변경하려면application/json을, 로고를 업로드하려면 multipart/form-data를 보내세요. 요청에 포함한 필드만 변경되며, 나머지 값은 그대로 유지됩니다.
사용 시기
- 흐름에 테마 적용 - 브랜드 색상, 글꼴, 모서리 반경을 설정합니다.
- 로고 업로드: 정사각형 로고, 직사각형 로고와 다크 모드용 버전, 파비콘을 설정합니다.
- 경험 조정 - 공개 앱 이름, 개인정보 처리방침 URL, 환영 화면 건너뛰기나 진행률 표시줄 숨기기 같은 토글을 설정합니다.
로고 업로드
로고는multipart/form-data로 보내세요.
image_square: 가로세로 비율 1:1.image_rectangular: 가로세로 비율 2:1.image_rectangular_dark: 가로세로 비율 2:1. 다크 모드용 직사각형 로고이며, 어두운 배경에 표시됩니다.image_favicon: 최대 500 KB.
image_square, image_rectangular, image_rectangular_dark는 PNG, JPG 또는 WebP 이미지여야 하며, 긴 변이 512 px 이상이고 1 MB 이하여야 합니다.
SVG 파일은 거부됩니다.
응답에는 결과로 생성된 logo_square, logo_rectangular, logo_rectangular_dark, favicon URL이 포함됩니다.
로고를 삭제하려면 해당하는 delete_logo_square, delete_logo_rectangular, delete_logo_rectangular_dark 또는 delete_favicon 플래그를 true로 보내세요.
다크 모드 로고를 삭제하면 logo_rectangular_dark 값은 null이 됩니다.
한 요청에서 로고를 업로드하면서 같은 로고의 삭제 플래그도 보내면, 업로드가 우선 적용됩니다.
업로드가 거부되면 400이 반환되며, 필드 이름과 사유가 함께 표시됩니다. 예를 들면 다음과 같습니다.
{"image_rectangular_dark": ["Upload a PNG, JPG or WebP image."]}{"image_rectangular": ["Image must be at least 512 px on its long side. Got 400x200 image dimensions"]}{"image_rectangular": ["Image aspect ratio must be 2:1. Got 1024x1024 image dimensions"]}{"image_square": ["File size should not exceed 1 MB"]}
참고 사항
- 애플리케이션은 API 키로 식별되므로 경로 파라미터는 없습니다.
- 16진수 색상은
#RRGGBB또는#RRGGBBAA형식을 허용합니다.font_weight는 선택한font_family에서 사용할 수 있는 굵기여야 합니다. - 커스텀 도메인과 화이트 라벨 이메일은 여기에서 설정할 수 없습니다. 이들은 Business Console에서 관리하세요.
권한
API 키에 해당 애플리케이션의 커스터마이징을 업데이트할 권한이 있어야 합니다.관련 문서
인증
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 를 참고하십시오.
본문
부분 브랜딩 업데이트 본문입니다. 변경하려는 필드만 제공하십시오. 16진수 색상은 #RRGGBB 또는 #RRGGBBAA를 허용합니다. 커스텀 도메인 및 화이트 라벨 이메일은 여기서 허용되지 않습니다.
헤더 / 기본 텍스트 색상입니다.
본문 / 보조 텍스트 색상입니다.
페이지 배경색입니다.
패널 / 강조 색상입니다.
불투명도 10%의 패널 색상입니다.
패널의 보조 텍스트 색상입니다.
패널의 필(pill)/배지 색상입니다.
배경 위의 텍스트 색상입니다.
기본 버튼 색상입니다.
보조 버튼 색상.
기본 버튼 텍스트 색상입니다.
보조 버튼 텍스트 색상.
필, 입력란 및 선택기의 텍스트 색상입니다.
패널 모서리 곡률(픽셀 단위)입니다.
x >= 0버튼 모서리 반경(픽셀 단위)입니다.
x >= 0Google Font 글꼴 패밀리 이름(예: Inter, AR One Sans).
선택한 글꼴 패밀리에서 사용 가능한 굵기(예: regular, 500, 700).
인증 워크플로에 표시되는 공개 이름입니다.
최종 사용자에게 표시되는 개인정보 처리방침 URL입니다.
초기 환영 화면을 건너뜁니다.
Didit으로 로그인 화면을 표시하는 대신 게스트로 계속 진행합니다. 커스텀 도메인이 구성되어 있는 동안에는 다시 false로 설정할 수 없습니다(400).
플로우 진행 중 진행률 표시줄을 숨깁니다.
콜백 URL로 리디렉션하기 전 지연 시간(초)입니다.
x >= 0true인 경우 현재 정사각형 로고를 제거합니다.
true인 경우 현재 직사각형 로고를 제거합니다.
true인 경우 현재 다크 모드 로고를 제거하며, 이후 logo_rectangular_dark는 null로 표시됩니다. 동일한 멀티파트 요청에서 image_rectangular_dark도 업로드하는 경우 업로드가 우선 적용됩니다.
true인 경우 현재 파비콘을 제거합니다.
응답
브랜딩이 업데이트되었습니다. 전체 브랜딩 객체가 반환됩니다(변경된 필드뿐만 아니라 모든 필드 포함).
애플리케이션을 위한 화이트 라벨 브랜딩: 색상, 글꼴, 모서리 곡률, 로고 URL 및 UI/UX 옵션입니다. 로고 URL은 읽기 전용입니다(이미지를 업로드하여 설정). 사용자 지정 도메인 및 화이트 라벨 이메일은 포함되지 않습니다.
읽기 전용입니다. 선택한 글꼴 모음에 대해 확인된 Google Fonts 스타일시트 URL입니다.
정사각형 로고의 읽기 전용 URL입니다. image_square를 통해 업로드합니다.
직사각형 로고의 읽기 전용 URL입니다. image_rectangular를 통해 업로드합니다.
읽기 전용입니다. 다크 모드용 직사각형 로고의 서명된 임시 URL로, 어두운 배경에 표시됩니다. 다크 모드 로고가 설정되어 있지 않거나 계정에 직사각형 로고가 표시되지 않는 경우 null입니다. image_rectangular_dark로 업로드합니다.
파비콘의 읽기 전용 URL입니다. image_favicon을 통해 업로드합니다.