attestid_js_sdk 0.1.11 → 0.1.13

package/dist/react/index.d.cts

@@ -68,10 +68,35 @@ interface LivenessCredentials {
     expiration: string;
     region: string;
 }
+/**
+ * Whether to ask for the back of a national ID / driver's licence. Each
+ * company decides on the AttestID dashboard (Settings):
+ *   - 'off'      — don't ask; a back sent anyway is ignored by the API.
+ *   - 'optional' — ask, and let the user skip it.
+ *   - 'required' — the back must be sent and its MRZ must be readable,
+ *                  otherwise POST /kyc/start fails with
+ *                  document_back_required / document_back_unreadable.
+ * Never applies to passports.
+ */
+type DocumentBackPolicy = 'off' | 'optional' | 'required';
+/** What the document capture should ask for, as set by the company. */
+interface CaptureSettings {
+    document_back: DocumentBackPolicy;
+}
 interface StartKYCOptions {
     userId: string;
     idType: IdType;
     idPhoto: File | Blob;
+    /**
+     * Optional photo of the BACK of a national ID / driver's licence. Many
+     * cards (ICAO 9303 TD1) print their machine-readable zone (MRZ) on the back;
+     * when this photo carries one, the API cross-checks its date of birth and
+     * expiry against the front and rejects a mismatch (document_sides_mismatch).
+     * A back with no MRZ is ignored, never a failure. Not accepted with
+     * idType 'passport'. Use checkBackPhotoQuality() to tell the user whether
+     * an MRZ was found before sending it.
+     */
+    idPhotoBack?: File | Blob;
     /**
      * Stated purpose for biometric processing. Defaults to 'identity_verification'.
      * One of: 'identity_verification', 'kyc_onboarding', 'kyc_refresh',
@@ -219,6 +244,12 @@ declare class AttestID {
      * TypeScript's type check are still rejected here at runtime.
      */
     startVerification(options: StartKYCOptions): Promise<StartKYCResponse>;
+    /**
+     * The company's capture settings, set on the AttestID dashboard. Read
+     * `document_back` before the document step to know whether to ask for the
+     * back of a national ID / driver's licence (see DocumentBackPolicy).
+     */
+    getCaptureSettings(userId: string): Promise<CaptureSettings>;
     /**
      * Fetch temporary AWS credentials and the Cognito identity pool ID from the
      * backend. Call this alongside startVerification() for the same userId to

package/dist/react/index.d.ts

@@ -68,10 +68,35 @@ interface LivenessCredentials {
     expiration: string;
     region: string;
 }
+/**
+ * Whether to ask for the back of a national ID / driver's licence. Each
+ * company decides on the AttestID dashboard (Settings):
+ *   - 'off'      — don't ask; a back sent anyway is ignored by the API.
+ *   - 'optional' — ask, and let the user skip it.
+ *   - 'required' — the back must be sent and its MRZ must be readable,
+ *                  otherwise POST /kyc/start fails with
+ *                  document_back_required / document_back_unreadable.
+ * Never applies to passports.
+ */
+type DocumentBackPolicy = 'off' | 'optional' | 'required';
+/** What the document capture should ask for, as set by the company. */
+interface CaptureSettings {
+    document_back: DocumentBackPolicy;
+}
 interface StartKYCOptions {
     userId: string;
     idType: IdType;
     idPhoto: File | Blob;
+    /**
+     * Optional photo of the BACK of a national ID / driver's licence. Many
+     * cards (ICAO 9303 TD1) print their machine-readable zone (MRZ) on the back;
+     * when this photo carries one, the API cross-checks its date of birth and
+     * expiry against the front and rejects a mismatch (document_sides_mismatch).
+     * A back with no MRZ is ignored, never a failure. Not accepted with
+     * idType 'passport'. Use checkBackPhotoQuality() to tell the user whether
+     * an MRZ was found before sending it.
+     */
+    idPhotoBack?: File | Blob;
     /**
      * Stated purpose for biometric processing. Defaults to 'identity_verification'.
      * One of: 'identity_verification', 'kyc_onboarding', 'kyc_refresh',
@@ -219,6 +244,12 @@ declare class AttestID {
      * TypeScript's type check are still rejected here at runtime.
      */
     startVerification(options: StartKYCOptions): Promise<StartKYCResponse>;
+    /**
+     * The company's capture settings, set on the AttestID dashboard. Read
+     * `document_back` before the document step to know whether to ask for the
+     * back of a national ID / driver's licence (see DocumentBackPolicy).
+     */
+    getCaptureSettings(userId: string): Promise<CaptureSettings>;
     /**
      * Fetch temporary AWS credentials and the Cognito identity pool ID from the
      * backend. Call this alongside startVerification() for the same userId to