@uverifyng/node 0.1.1 → 0.2.0

package/README.md

@@ -54,6 +54,12 @@ await uverify.aml.monitors.create({ name: 'Adaeze Okafor' });                //
 
 const link = await uverify.kyc.createLink({ customer_name: 'Ada', require_document: true }); // no-code: send link.url
 
+await uverify.address.verify({ address: '12 Admiralty Way, Lekki Phase 1', lga: 'Eti-Osa', state: 'Lagos' }); // on the map, in that LGA and state?
+const home = await uverify.address.createLink({ address: '12 Admiralty Way', state: 'Lagos', customer_name: 'Ada' });
+// send home.url: they open it at home and share their phone's location; read home.result / location.distance_m later
+// (require_document: true also asks them for a proof of address)
+await uverify.address.verifyDocument({ front_image: fs.readFileSync('bill.jpg'), address: '12 Admiralty Way', state: 'Lagos', name: 'Adaeze Okafor' });
+
 await uverify.verifications.list({ status: 'verified' });
 await uverify.account.balance();
 ```

package/dist/index.cjs

@@ -99,7 +99,7 @@ function signPayload(body, secret, timestamp = Math.floor(Date.now() / 1e3)) {
 }
 
 // src/client.ts
-var VERSION = "0.1.1";
+var VERSION = "0.2.0";
 var DEFAULT_BASE_URL = "https://api.uverify.com.ng/v1";
 var IMAGE_FIELDS = ["selfie_image", "front_image", "back_image"];
 var newReference = (prefix) => `${prefix}_${(0, import_node_crypto2.randomBytes)(9).toString("base64url")}`;
@@ -114,6 +114,7 @@ var UVerify = class _UVerify {
   liveness;
   documents;
   aml;
+  address;
   kyc;
   account;
   static webhooks = { constructEvent, signPayload };
@@ -139,6 +140,7 @@ var UVerify = class _UVerify {
     this.liveness = new LivenessResource(this);
     this.documents = new DocumentsResource(this);
     this.aml = new AmlResource(this);
+    this.address = new AddressResource(this);
     this.kyc = new KycResource(this);
     this.account = new AccountResource(this);
   }
@@ -305,6 +307,42 @@ var AmlMonitorsResource = class extends Resource {
     return this.client.request("DELETE", `/aml/monitors/${encodeURIComponent(id)}`, { retryable: true });
   }
 };
+var AddressResource = class extends Resource {
+  /** Is the address real, and in the LGA and state given? Found on the map and scored, instantly. */
+  verify(params) {
+    return this.client.create("/address/verify", params, "addr");
+  }
+  getCheck(id) {
+    return this.client.request("GET", `/address/checks/${encodeURIComponent(id)}`);
+  }
+  listChecks(params = {}) {
+    return this.client.request("GET", "/address/checks", { query: { ...params } });
+  }
+  /** A link the customer opens at home to share their phone's location. Send them `link.url`. */
+  createLink(params) {
+    return this.client.create("/address/links", params, "addrl");
+  }
+  getLink(id) {
+    return this.client.request("GET", `/address/links/${encodeURIComponent(id)}`);
+  }
+  listLinks(params = {}) {
+    return this.client.request("GET", "/address/links", { query: { ...params } });
+  }
+  /** A utility bill, bank statement or tenancy agreement, checked for the customer's name, the address, its date and editing. */
+  verifyDocument(params) {
+    return this.client.create("/address/documents", params, "addrd");
+  }
+  getDocument(id) {
+    return this.client.request("GET", `/address/documents/${encodeURIComponent(id)}`);
+  }
+  listDocuments(params = {}) {
+    return this.client.request("GET", "/address/documents", { query: { ...params } });
+  }
+  /** Sandbox only: finish a link without a phone. */
+  simulateLink(id, params) {
+    return this.client.request("POST", `/address/links/${encodeURIComponent(id)}/simulate`, { body: { ...params } });
+  }
+};
 var AmlResource = class extends Resource {
   monitors = new AmlMonitorsResource(this.client);
   /** Screen a person or organisation against the UN, OFAC, UK, EU and Nigeria sanctions lists. */

package/dist/index.d.cts

@@ -215,6 +215,211 @@ interface AmlScreening {
     created_at: string;
 }
 type MonitorParams = Omit<ScreenParams, 'monitor'>;
+interface VerifyAddressParams {
+    /** House number and street, with the area or town, e.g. "12 Admiralty Way, Lekki Phase 1". */
+    address: string;
+    /** A Nigerian state or FCT, e.g. "Lagos". */
+    state: string;
+    /** Local government area, e.g. "Eti-Osa". Optional, but it sharpens the check. */
+    lga?: string;
+    reference?: string;
+    /** Sandbox only: the result to get back. */
+    sandbox_outcome?: 'verified' | 'partial' | 'not_found' | 'state_mismatch';
+}
+type AddressPrecision = 'building' | 'street' | 'area' | 'region';
+interface AddressChecks {
+    address_found: {
+        result: 'pass' | 'fail';
+        precision: AddressPrecision | null;
+    };
+    state_match: {
+        result: 'pass' | 'fail';
+        found: string | null;
+    };
+    lga_match: {
+        result: 'pass' | 'fail' | 'unknown';
+        found: string | null;
+    };
+}
+/** An address found on the map and scored. */
+interface AddressCheck {
+    id: string;
+    reference: string;
+    environment: Environment;
+    /** verified (score 75+), partial (45–74) or failed. */
+    status: 'verified' | 'partial' | 'failed';
+    score: number;
+    address: {
+        address: string;
+        lga: string | null;
+        state: string;
+    } | null;
+    checks: AddressChecks;
+    /** e.g. address_not_found, state_mismatch, lga_mismatch, only_area_found. */
+    reasons: string[];
+    location: {
+        formatted_address: string;
+        latitude: number;
+        longitude: number;
+        precision: AddressPrecision | null;
+        partial_match: boolean;
+        source: 'openstreetmap' | 'google' | 'sandbox';
+        /** Show it wherever you display an OpenStreetMap result. */
+        attribution?: string;
+    } | null;
+    data_deleted_at?: string;
+    amount_charged: number;
+    currency: 'NGN';
+    created_at: string;
+}
+interface ListAddressChecksParams extends PageParams {
+    status?: AddressCheck['status'];
+}
+interface CreateAddressLinkParams {
+    /** Must be findable on the map, or the API answers 422 and no link is made. */
+    address: string;
+    state: string;
+    lga?: string;
+    /** Greets the customer on the page. */
+    customer_name?: string;
+    /** https:// URL the customer goes to when done; address_link_id, status and reference are appended. */
+    redirect_url?: string;
+    reference?: string;
+    /** After their location, the customer also photographs a proof of address (charged as its own check). */
+    require_document?: boolean;
+    /** Sandbox only: the result sharing a location gives. */
+    sandbox_outcome?: 'verified' | 'partial' | 'failed';
+}
+/** A link the customer opens at home to share their phone's location, compared with the address. */
+interface AddressLink {
+    id: string;
+    object: 'address_link';
+    reference: string;
+    environment: Environment;
+    status: 'pending' | 'completed' | 'expired';
+    /** Once completed: the weaker of the address check and the location check. */
+    result: 'verified' | 'partial' | 'failed' | null;
+    address: {
+        address: string;
+        lga: string | null;
+        state: string;
+    } | null;
+    customer_name: string | null;
+    address_check: {
+        status: AddressCheck['status'];
+        score: number;
+        checks: AddressChecks;
+    };
+    place: {
+        formatted_address: string;
+        latitude: number;
+        longitude: number;
+        precision: AddressPrecision | null;
+        source: string;
+        attribution?: string;
+    } | null;
+    location: {
+        distance_m: number | null;
+        accuracy_m: number | null;
+        /** The phone's own street, area or LGA was named in the address (checked when it was far from the map's pin). */
+        area_match: 'street' | 'area' | 'lga' | null;
+        latitude: number | null;
+        longitude: number | null;
+        captured_at: string | null;
+    } | null;
+    reasons: string[];
+    attempts: number;
+    require_document: boolean;
+    /** When asked for: the proof of address (fetch it with address.getDocument), or missing / unavailable. */
+    document: {
+        id: string | null;
+        status: AddressDocument['status'] | 'missing' | 'unavailable' | null;
+    } | null;
+    redirect_url: string | null;
+    expires_at: string;
+    completed_at: string | null;
+    data_deleted_at?: string;
+    amount_charged: number;
+    currency: 'NGN';
+    created_at: string;
+    /** Only on create: the link to send the customer (its token is in the #fragment). */
+    url?: string;
+}
+interface ListAddressLinksParams extends PageParams {
+    status?: AddressLink['status'];
+}
+interface VerifyAddressDocumentParams {
+    /** A photo or screenshot of the bill, statement or tenancy agreement (Buffer or base64; JPEG, PNG or WEBP). */
+    front_image: ImageInput;
+    /** A second page, if the name or address is on it. */
+    back_image?: ImageInput;
+    /** The address it should show. */
+    address: string;
+    state: string;
+    lga?: string;
+    /** The customer's full name, compared with the name on the document. */
+    name?: string;
+    /** How recent it must be, in days (default 92). */
+    max_age_days?: number;
+    reference?: string;
+    /** Sandbox only: the result to act out. */
+    sandbox_outcome?: 'verified' | 'address_mismatch' | 'name_mismatch' | 'too_old' | 'tampered' | 'unreadable';
+}
+/** A proof of address read and checked against the customer's name and address. */
+interface AddressDocument {
+    id: string;
+    object: 'address_document';
+    reference: string;
+    environment: Environment;
+    /** unreadable is refunded: ask for a clearer photo. */
+    status: 'verified' | 'partial' | 'failed' | 'unreadable';
+    /** e.g. name_mismatch, address_partial, document_too_old, tampering_suspected. */
+    reasons: string[];
+    address: {
+        address: string;
+        lga: string | null;
+        state: string;
+    } | null;
+    name: string | null;
+    checks: {
+        document_type: 'utility_bill' | 'bank_statement' | 'tenancy_agreement' | 'government_letter' | 'other';
+        name_match: {
+            result: 'pass' | 'partial' | 'fail' | 'unknown';
+        };
+        address_match: {
+            result: 'pass' | 'partial' | 'fail';
+            score: number;
+            state_on_document: boolean | null;
+            lga_on_document: boolean | null;
+        };
+        recency: {
+            result: 'pass' | 'fail' | 'unknown';
+            issue_date: string | null;
+            age_days: number | null;
+            max_age_days: number;
+        };
+        tampering_signals: string[];
+    } | null;
+    /** What was read off it. */
+    extracted: {
+        document_type: string;
+        issuer: string | null;
+        name: string | null;
+        address: string | null;
+        issue_date: string | null;
+    } | null;
+    address_link_id: string | null;
+    data_deleted_at?: string;
+    amount_charged: number;
+    currency: 'NGN';
+    created_at: string;
+}
+interface ListAddressDocumentsParams extends PageParams {
+    status?: AddressDocument['status'];
+}
+interface SimulateAddressLinkParams {
+    outcome: 'verified' | 'partial' | 'failed' | 'expired';
+}
 interface AmlMonitor {
     id: string;
     reference: string;
@@ -310,7 +515,7 @@ interface Price {
     currency: 'NGN';
     is_enabled: boolean;
 }
-type WebhookEventType = 'verification.completed' | 'liveness.completed' | 'kyc.completed' | 'document.completed' | 'aml.match_found' | 'webhook.test';
+type WebhookEventType = 'verification.completed' | 'liveness.completed' | 'kyc.completed' | 'document.completed' | 'aml.match_found' | 'address.completed' | 'webhook.test';
 interface WebhookEvent<T = unknown> {
     /** Unique per event; deliveries can repeat, so dedupe on it. */
     id: string;
@@ -333,7 +538,7 @@ declare function constructEvent<T = unknown>(rawBody: string | Buffer | Uint8Arr
 /** Sign a payload the way UVerify does, for your own tests. */
 declare function signPayload(body: string, secret: string, timestamp?: number): string;
 
-declare const VERSION = "0.1.1";
+declare const VERSION = "0.2.0";
 interface UVerifyOptions {
     /** uvk_test_… (sandbox, free) or uvk_live_…. Defaults to the UVERIFY_API_KEY environment variable. */
     apiKey?: string;
@@ -369,6 +574,7 @@ declare class UVerify {
     readonly liveness: LivenessResource;
     readonly documents: DocumentsResource;
     readonly aml: AmlResource;
+    readonly address: AddressResource;
     readonly kyc: KycResource;
     readonly account: AccountResource;
     static readonly webhooks: {
@@ -447,6 +653,22 @@ declare class AmlMonitorsResource extends Resource {
     /** Stop watching a name. */
     stop(id: string): Promise<AmlMonitor>;
 }
+declare class AddressResource extends Resource {
+    /** Is the address real, and in the LGA and state given? Found on the map and scored, instantly. */
+    verify(params: VerifyAddressParams): Promise<AddressCheck>;
+    getCheck(id: string): Promise<AddressCheck>;
+    listChecks(params?: ListAddressChecksParams): Promise<Page<AddressCheck>>;
+    /** A link the customer opens at home to share their phone's location. Send them `link.url`. */
+    createLink(params: CreateAddressLinkParams): Promise<AddressLink>;
+    getLink(id: string): Promise<AddressLink>;
+    listLinks(params?: ListAddressLinksParams): Promise<Page<AddressLink>>;
+    /** A utility bill, bank statement or tenancy agreement, checked for the customer's name, the address, its date and editing. */
+    verifyDocument(params: VerifyAddressDocumentParams): Promise<AddressDocument>;
+    getDocument(id: string): Promise<AddressDocument>;
+    listDocuments(params?: ListAddressDocumentsParams): Promise<Page<AddressDocument>>;
+    /** Sandbox only: finish a link without a phone. */
+    simulateLink(id: string, params: SimulateAddressLinkParams): Promise<AddressLink>;
+}
 declare class AmlResource extends Resource {
     readonly monitors: AmlMonitorsResource;
     /** Screen a person or organisation against the UN, OFAC, UK, EU and Nigeria sanctions lists. */
@@ -495,4 +717,4 @@ declare class UVerifySignatureError extends Error {
     constructor(message: string);
 }
 
-export { type AmlMatch, type AmlMonitor, type AmlScreening, type AmlSummary, type Balance, type CacCheckParams, type CreateKycLinkParams, type CreateLivenessParams, type DocumentType, type Environment, type FaceInput, type IdDocument, type ImageInput, type KycLink, type ListKycLinksParams, type ListVerificationsParams, type LivenessSession, type MonitorParams, type NamedCheckParams, type Page, type PageParams, type PersonCheckParams, type Price, type SanctionsList, type ScreenParams, type SimulateLivenessParams, UVerify, UVerifyConnectionError, UVerifyError, type UVerifyOptions, UVerifySignatureError, VERSION, type Verification, type VerifyDocumentParams, type WebhookEvent, type WebhookEventType, constructEvent, UVerify as default, signPayload };
+export { type AddressCheck, type AddressChecks, type AddressDocument, type AddressLink, type AddressPrecision, type AmlMatch, type AmlMonitor, type AmlScreening, type AmlSummary, type Balance, type CacCheckParams, type CreateAddressLinkParams, type CreateKycLinkParams, type CreateLivenessParams, type DocumentType, type Environment, type FaceInput, type IdDocument, type ImageInput, type KycLink, type ListAddressChecksParams, type ListAddressDocumentsParams, type ListAddressLinksParams, type ListKycLinksParams, type ListVerificationsParams, type LivenessSession, type MonitorParams, type NamedCheckParams, type Page, type PageParams, type PersonCheckParams, type Price, type SanctionsList, type ScreenParams, type SimulateAddressLinkParams, type SimulateLivenessParams, UVerify, UVerifyConnectionError, UVerifyError, type UVerifyOptions, UVerifySignatureError, VERSION, type Verification, type VerifyAddressDocumentParams, type VerifyAddressParams, type VerifyDocumentParams, type WebhookEvent, type WebhookEventType, constructEvent, UVerify as default, signPayload };

package/dist/index.d.ts

@@ -215,6 +215,211 @@ interface AmlScreening {
     created_at: string;
 }
 type MonitorParams = Omit<ScreenParams, 'monitor'>;
+interface VerifyAddressParams {
+    /** House number and street, with the area or town, e.g. "12 Admiralty Way, Lekki Phase 1". */
+    address: string;
+    /** A Nigerian state or FCT, e.g. "Lagos". */
+    state: string;
+    /** Local government area, e.g. "Eti-Osa". Optional, but it sharpens the check. */
+    lga?: string;
+    reference?: string;
+    /** Sandbox only: the result to get back. */
+    sandbox_outcome?: 'verified' | 'partial' | 'not_found' | 'state_mismatch';
+}
+type AddressPrecision = 'building' | 'street' | 'area' | 'region';
+interface AddressChecks {
+    address_found: {
+        result: 'pass' | 'fail';
+        precision: AddressPrecision | null;
+    };
+    state_match: {
+        result: 'pass' | 'fail';
+        found: string | null;
+    };
+    lga_match: {
+        result: 'pass' | 'fail' | 'unknown';
+        found: string | null;
+    };
+}
+/** An address found on the map and scored. */
+interface AddressCheck {
+    id: string;
+    reference: string;
+    environment: Environment;
+    /** verified (score 75+), partial (45–74) or failed. */
+    status: 'verified' | 'partial' | 'failed';
+    score: number;
+    address: {
+        address: string;
+        lga: string | null;
+        state: string;
+    } | null;
+    checks: AddressChecks;
+    /** e.g. address_not_found, state_mismatch, lga_mismatch, only_area_found. */
+    reasons: string[];
+    location: {
+        formatted_address: string;
+        latitude: number;
+        longitude: number;
+        precision: AddressPrecision | null;
+        partial_match: boolean;
+        source: 'openstreetmap' | 'google' | 'sandbox';
+        /** Show it wherever you display an OpenStreetMap result. */
+        attribution?: string;
+    } | null;
+    data_deleted_at?: string;
+    amount_charged: number;
+    currency: 'NGN';
+    created_at: string;
+}
+interface ListAddressChecksParams extends PageParams {
+    status?: AddressCheck['status'];
+}
+interface CreateAddressLinkParams {
+    /** Must be findable on the map, or the API answers 422 and no link is made. */
+    address: string;
+    state: string;
+    lga?: string;
+    /** Greets the customer on the page. */
+    customer_name?: string;
+    /** https:// URL the customer goes to when done; address_link_id, status and reference are appended. */
+    redirect_url?: string;
+    reference?: string;
+    /** After their location, the customer also photographs a proof of address (charged as its own check). */
+    require_document?: boolean;
+    /** Sandbox only: the result sharing a location gives. */
+    sandbox_outcome?: 'verified' | 'partial' | 'failed';
+}
+/** A link the customer opens at home to share their phone's location, compared with the address. */
+interface AddressLink {
+    id: string;
+    object: 'address_link';
+    reference: string;
+    environment: Environment;
+    status: 'pending' | 'completed' | 'expired';
+    /** Once completed: the weaker of the address check and the location check. */
+    result: 'verified' | 'partial' | 'failed' | null;
+    address: {
+        address: string;
+        lga: string | null;
+        state: string;
+    } | null;
+    customer_name: string | null;
+    address_check: {
+        status: AddressCheck['status'];
+        score: number;
+        checks: AddressChecks;
+    };
+    place: {
+        formatted_address: string;
+        latitude: number;
+        longitude: number;
+        precision: AddressPrecision | null;
+        source: string;
+        attribution?: string;
+    } | null;
+    location: {
+        distance_m: number | null;
+        accuracy_m: number | null;
+        /** The phone's own street, area or LGA was named in the address (checked when it was far from the map's pin). */
+        area_match: 'street' | 'area' | 'lga' | null;
+        latitude: number | null;
+        longitude: number | null;
+        captured_at: string | null;
+    } | null;
+    reasons: string[];
+    attempts: number;
+    require_document: boolean;
+    /** When asked for: the proof of address (fetch it with address.getDocument), or missing / unavailable. */
+    document: {
+        id: string | null;
+        status: AddressDocument['status'] | 'missing' | 'unavailable' | null;
+    } | null;
+    redirect_url: string | null;
+    expires_at: string;
+    completed_at: string | null;
+    data_deleted_at?: string;
+    amount_charged: number;
+    currency: 'NGN';
+    created_at: string;
+    /** Only on create: the link to send the customer (its token is in the #fragment). */
+    url?: string;
+}
+interface ListAddressLinksParams extends PageParams {
+    status?: AddressLink['status'];
+}
+interface VerifyAddressDocumentParams {
+    /** A photo or screenshot of the bill, statement or tenancy agreement (Buffer or base64; JPEG, PNG or WEBP). */
+    front_image: ImageInput;
+    /** A second page, if the name or address is on it. */
+    back_image?: ImageInput;
+    /** The address it should show. */
+    address: string;
+    state: string;
+    lga?: string;
+    /** The customer's full name, compared with the name on the document. */
+    name?: string;
+    /** How recent it must be, in days (default 92). */
+    max_age_days?: number;
+    reference?: string;
+    /** Sandbox only: the result to act out. */
+    sandbox_outcome?: 'verified' | 'address_mismatch' | 'name_mismatch' | 'too_old' | 'tampered' | 'unreadable';
+}
+/** A proof of address read and checked against the customer's name and address. */
+interface AddressDocument {
+    id: string;
+    object: 'address_document';
+    reference: string;
+    environment: Environment;
+    /** unreadable is refunded: ask for a clearer photo. */
+    status: 'verified' | 'partial' | 'failed' | 'unreadable';
+    /** e.g. name_mismatch, address_partial, document_too_old, tampering_suspected. */
+    reasons: string[];
+    address: {
+        address: string;
+        lga: string | null;
+        state: string;
+    } | null;
+    name: string | null;
+    checks: {
+        document_type: 'utility_bill' | 'bank_statement' | 'tenancy_agreement' | 'government_letter' | 'other';
+        name_match: {
+            result: 'pass' | 'partial' | 'fail' | 'unknown';
+        };
+        address_match: {
+            result: 'pass' | 'partial' | 'fail';
+            score: number;
+            state_on_document: boolean | null;
+            lga_on_document: boolean | null;
+        };
+        recency: {
+            result: 'pass' | 'fail' | 'unknown';
+            issue_date: string | null;
+            age_days: number | null;
+            max_age_days: number;
+        };
+        tampering_signals: string[];
+    } | null;
+    /** What was read off it. */
+    extracted: {
+        document_type: string;
+        issuer: string | null;
+        name: string | null;
+        address: string | null;
+        issue_date: string | null;
+    } | null;
+    address_link_id: string | null;
+    data_deleted_at?: string;
+    amount_charged: number;
+    currency: 'NGN';
+    created_at: string;
+}
+interface ListAddressDocumentsParams extends PageParams {
+    status?: AddressDocument['status'];
+}
+interface SimulateAddressLinkParams {
+    outcome: 'verified' | 'partial' | 'failed' | 'expired';
+}
 interface AmlMonitor {
     id: string;
     reference: string;
@@ -310,7 +515,7 @@ interface Price {
     currency: 'NGN';
     is_enabled: boolean;
 }
-type WebhookEventType = 'verification.completed' | 'liveness.completed' | 'kyc.completed' | 'document.completed' | 'aml.match_found' | 'webhook.test';
+type WebhookEventType = 'verification.completed' | 'liveness.completed' | 'kyc.completed' | 'document.completed' | 'aml.match_found' | 'address.completed' | 'webhook.test';
 interface WebhookEvent<T = unknown> {
     /** Unique per event; deliveries can repeat, so dedupe on it. */
     id: string;
@@ -333,7 +538,7 @@ declare function constructEvent<T = unknown>(rawBody: string | Buffer | Uint8Arr
 /** Sign a payload the way UVerify does, for your own tests. */
 declare function signPayload(body: string, secret: string, timestamp?: number): string;
 
-declare const VERSION = "0.1.1";
+declare const VERSION = "0.2.0";
 interface UVerifyOptions {
     /** uvk_test_… (sandbox, free) or uvk_live_…. Defaults to the UVERIFY_API_KEY environment variable. */
     apiKey?: string;
@@ -369,6 +574,7 @@ declare class UVerify {
     readonly liveness: LivenessResource;
     readonly documents: DocumentsResource;
     readonly aml: AmlResource;
+    readonly address: AddressResource;
     readonly kyc: KycResource;
     readonly account: AccountResource;
     static readonly webhooks: {
@@ -447,6 +653,22 @@ declare class AmlMonitorsResource extends Resource {
     /** Stop watching a name. */
     stop(id: string): Promise<AmlMonitor>;
 }
+declare class AddressResource extends Resource {
+    /** Is the address real, and in the LGA and state given? Found on the map and scored, instantly. */
+    verify(params: VerifyAddressParams): Promise<AddressCheck>;
+    getCheck(id: string): Promise<AddressCheck>;
+    listChecks(params?: ListAddressChecksParams): Promise<Page<AddressCheck>>;
+    /** A link the customer opens at home to share their phone's location. Send them `link.url`. */
+    createLink(params: CreateAddressLinkParams): Promise<AddressLink>;
+    getLink(id: string): Promise<AddressLink>;
+    listLinks(params?: ListAddressLinksParams): Promise<Page<AddressLink>>;
+    /** A utility bill, bank statement or tenancy agreement, checked for the customer's name, the address, its date and editing. */
+    verifyDocument(params: VerifyAddressDocumentParams): Promise<AddressDocument>;
+    getDocument(id: string): Promise<AddressDocument>;
+    listDocuments(params?: ListAddressDocumentsParams): Promise<Page<AddressDocument>>;
+    /** Sandbox only: finish a link without a phone. */
+    simulateLink(id: string, params: SimulateAddressLinkParams): Promise<AddressLink>;
+}
 declare class AmlResource extends Resource {
     readonly monitors: AmlMonitorsResource;
     /** Screen a person or organisation against the UN, OFAC, UK, EU and Nigeria sanctions lists. */
@@ -495,4 +717,4 @@ declare class UVerifySignatureError extends Error {
     constructor(message: string);
 }
 
-export { type AmlMatch, type AmlMonitor, type AmlScreening, type AmlSummary, type Balance, type CacCheckParams, type CreateKycLinkParams, type CreateLivenessParams, type DocumentType, type Environment, type FaceInput, type IdDocument, type ImageInput, type KycLink, type ListKycLinksParams, type ListVerificationsParams, type LivenessSession, type MonitorParams, type NamedCheckParams, type Page, type PageParams, type PersonCheckParams, type Price, type SanctionsList, type ScreenParams, type SimulateLivenessParams, UVerify, UVerifyConnectionError, UVerifyError, type UVerifyOptions, UVerifySignatureError, VERSION, type Verification, type VerifyDocumentParams, type WebhookEvent, type WebhookEventType, constructEvent, UVerify as default, signPayload };
+export { type AddressCheck, type AddressChecks, type AddressDocument, type AddressLink, type AddressPrecision, type AmlMatch, type AmlMonitor, type AmlScreening, type AmlSummary, type Balance, type CacCheckParams, type CreateAddressLinkParams, type CreateKycLinkParams, type CreateLivenessParams, type DocumentType, type Environment, type FaceInput, type IdDocument, type ImageInput, type KycLink, type ListAddressChecksParams, type ListAddressDocumentsParams, type ListAddressLinksParams, type ListKycLinksParams, type ListVerificationsParams, type LivenessSession, type MonitorParams, type NamedCheckParams, type Page, type PageParams, type PersonCheckParams, type Price, type SanctionsList, type ScreenParams, type SimulateAddressLinkParams, type SimulateLivenessParams, UVerify, UVerifyConnectionError, UVerifyError, type UVerifyOptions, UVerifySignatureError, VERSION, type Verification, type VerifyAddressDocumentParams, type VerifyAddressParams, type VerifyDocumentParams, type WebhookEvent, type WebhookEventType, constructEvent, UVerify as default, signPayload };

package/dist/index.js

@@ -66,7 +66,7 @@ function signPayload(body, secret, timestamp = Math.floor(Date.now() / 1e3)) {
 }
 
 // src/client.ts
-var VERSION = "0.1.1";
+var VERSION = "0.2.0";
 var DEFAULT_BASE_URL = "https://api.uverify.com.ng/v1";
 var IMAGE_FIELDS = ["selfie_image", "front_image", "back_image"];
 var newReference = (prefix) => `${prefix}_${randomBytes(9).toString("base64url")}`;
@@ -81,6 +81,7 @@ var UVerify = class _UVerify {
   liveness;
   documents;
   aml;
+  address;
   kyc;
   account;
   static webhooks = { constructEvent, signPayload };
@@ -106,6 +107,7 @@ var UVerify = class _UVerify {
     this.liveness = new LivenessResource(this);
     this.documents = new DocumentsResource(this);
     this.aml = new AmlResource(this);
+    this.address = new AddressResource(this);
     this.kyc = new KycResource(this);
     this.account = new AccountResource(this);
   }
@@ -272,6 +274,42 @@ var AmlMonitorsResource = class extends Resource {
     return this.client.request("DELETE", `/aml/monitors/${encodeURIComponent(id)}`, { retryable: true });
   }
 };
+var AddressResource = class extends Resource {
+  /** Is the address real, and in the LGA and state given? Found on the map and scored, instantly. */
+  verify(params) {
+    return this.client.create("/address/verify", params, "addr");
+  }
+  getCheck(id) {
+    return this.client.request("GET", `/address/checks/${encodeURIComponent(id)}`);
+  }
+  listChecks(params = {}) {
+    return this.client.request("GET", "/address/checks", { query: { ...params } });
+  }
+  /** A link the customer opens at home to share their phone's location. Send them `link.url`. */
+  createLink(params) {
+    return this.client.create("/address/links", params, "addrl");
+  }
+  getLink(id) {
+    return this.client.request("GET", `/address/links/${encodeURIComponent(id)}`);
+  }
+  listLinks(params = {}) {
+    return this.client.request("GET", "/address/links", { query: { ...params } });
+  }
+  /** A utility bill, bank statement or tenancy agreement, checked for the customer's name, the address, its date and editing. */
+  verifyDocument(params) {
+    return this.client.create("/address/documents", params, "addrd");
+  }
+  getDocument(id) {
+    return this.client.request("GET", `/address/documents/${encodeURIComponent(id)}`);
+  }
+  listDocuments(params = {}) {
+    return this.client.request("GET", "/address/documents", { query: { ...params } });
+  }
+  /** Sandbox only: finish a link without a phone. */
+  simulateLink(id, params) {
+    return this.client.request("POST", `/address/links/${encodeURIComponent(id)}/simulate`, { body: { ...params } });
+  }
+};
 var AmlResource = class extends Resource {
   monitors = new AmlMonitorsResource(this.client);
   /** Screen a person or organisation against the UN, OFAC, UK, EU and Nigeria sanctions lists. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uverifyng/node",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Official Node.js library for the UVerify API: BVN, NIN and ID checks, liveness, face match, ID documents and AML screening for Nigeria.",
   "license": "MIT",
   "author": "Elasto Web Services Limited",