@vouchsafe/node 0.1.76 → 0.1.77
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -135,6 +135,38 @@ console.log(result.validations.document_age_valid?.status)
|
|
|
135
135
|
- Utilities: `UtilityBill`, `MobilePhoneBill`
|
|
136
136
|
- Government: `BenefitsLetter`, `HMPPSLetter`, `NHSLetter`
|
|
137
137
|
|
|
138
|
+
### Verify a photo ID
|
|
139
|
+
|
|
140
|
+
Extract and validate a photo ID (passport, national ID, driving licence, PASS card, or unfamiliar photo ID), optionally face-matching it against a selfie:
|
|
141
|
+
|
|
142
|
+
```ts
|
|
143
|
+
import fs from "fs"
|
|
144
|
+
|
|
145
|
+
const front = new File([fs.readFileSync("./licence-front.jpg")], "licence-front.jpg", {
|
|
146
|
+
type: "image/jpeg",
|
|
147
|
+
})
|
|
148
|
+
|
|
149
|
+
const result = await client.verifyPhotoId({
|
|
150
|
+
sub_type: "DrivingLicence", // Passport | NationalId | DrivingLicence | PASSCard | UnfamiliarPhotoId
|
|
151
|
+
front,
|
|
152
|
+
country_code: "GB", // DrivingLicence only
|
|
153
|
+
// back, // NationalId only
|
|
154
|
+
// face_scan, // Optional selfie to face-match
|
|
155
|
+
})
|
|
156
|
+
|
|
157
|
+
console.log(result.outcome) // 'pass' or 'fail'
|
|
158
|
+
console.log(result.extracted_details.first_name)
|
|
159
|
+
console.log(result.validations.has_not_expired?.status)
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
**Sub types**:
|
|
163
|
+
|
|
164
|
+
- `Passport` — MRZ-enabled passports
|
|
165
|
+
- `NationalId` — MRZ-enabled national IDs (requires `back`)
|
|
166
|
+
- `DrivingLicence` — GB and EU licences (requires `country_code`)
|
|
167
|
+
- `PASSCard` — PASS-accredited cards (Citizencard, Young Scot)
|
|
168
|
+
- `UnfamiliarPhotoId` — any other photo ID
|
|
169
|
+
|
|
138
170
|
### List verification flows
|
|
139
171
|
|
|
140
172
|
```ts
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { RequestVerificationInput, SmartLookupInput, ListVerificationsParams, EvisaVerificationInput, VerifySupportingDocumentBody } from "./openapi/models";
|
|
1
|
+
import type { RequestVerificationInput, SmartLookupInput, ListVerificationsParams, EvisaVerificationInput, VerifySupportingDocumentBody, VerifyPhotoIdBody } from "./openapi/models";
|
|
2
2
|
interface VouchsafeClientOptions {
|
|
3
3
|
client_id: string;
|
|
4
4
|
client_secret: string;
|
|
@@ -51,6 +51,12 @@ export declare class VouchsafeClient {
|
|
|
51
51
|
* Supported sub_types: Payslip, BankStatement, UtilityBill, etc.
|
|
52
52
|
*/
|
|
53
53
|
verifySupportingDocument(input: VerifySupportingDocumentBody): Promise<import("./openapi/models").SupportingDocumentVerificationResponse>;
|
|
54
|
+
/**
|
|
55
|
+
* Extract and validate a photo ID (passport, national ID, driving licence, PASS card,
|
|
56
|
+
* or unfamiliar photo ID), optionally face-matching against a supplied face scan.
|
|
57
|
+
* sub_types: Passport, NationalId, DrivingLicence, PASSCard, UnfamiliarPhotoId
|
|
58
|
+
*/
|
|
59
|
+
verifyPhotoId(input: VerifyPhotoIdBody): Promise<import("./openapi/models").PhotoIdVerificationResponse>;
|
|
54
60
|
}
|
|
55
61
|
export {};
|
|
56
62
|
//# sourceMappingURL=VouchsafeClient.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VouchsafeClient.d.ts","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"VouchsafeClient.d.ts","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAEV,wBAAwB,EACxB,gBAAgB,EAChB,uBAAuB,EACvB,sBAAsB,EACtB,4BAA4B,EAC5B,iBAAiB,EAClB,MAAM,kBAAkB,CAAA;AAEzB,UAAU,sBAAsB;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IAEjC,UAAU,EAAE,MAAM;IAClB,YAAY,EAAE,OAAO;gBADrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,OAAO,EAC5B,OAAO,CAAC,EAAE,MAAM;CAKnB;AAED,qBAAa,eAAe;IAId,OAAO,CAAC,OAAO;IAH3B,OAAO,CAAC,KAAK,CAAC,CAAQ;IACtB,OAAO,CAAC,WAAW,CAAC,CAAM;gBAEN,OAAO,EAAE,sBAAsB;IAEnD;;OAEG;IAEH,OAAO,CAAC,cAAc,CA+BrB;IAGD,OAAO,CAAC,WAAW,CAGlB;IAGD,OAAO,CAAC,iBAAiB,CA+BxB;IAED;;OAEG;IAEG,eAAe,CAAC,EAAE,EAAE,EAAE,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE;IAItC,iBAAiB,CAAC,MAAM,CAAC,EAAE,uBAAuB;IAIlD,mBAAmB,CAAC,KAAK,EAAE,wBAAwB;IAInD,kBAAkB,CAAC,KAAK,EAAE,gBAAgB;IAI1C,cAAc,CAAC,EAAE,QAAQ,EAAE,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE;IAIjD,SAAS;IAIT,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE;IAIpC;;OAEG;IACG,WAAW,CAAC,EAAE,YAAY,EAAE,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE;IAI5D;;;OAGG;IACG,WAAW,CAAC,KAAK,EAAE,sBAAsB;IAI/C;;;OAGG;IACG,wBAAwB,CAAC,KAAK,EAAE,4BAA4B;IAIlE;;;;OAIG;IACG,aAAa,CAAC,KAAK,EAAE,iBAAiB;CAG7C"}
|
package/dist/VouchsafeClient.js
CHANGED
|
@@ -113,6 +113,14 @@ class VouchsafeClient {
|
|
|
113
113
|
async verifySupportingDocument(input) {
|
|
114
114
|
return this.withErrorHandling((opts) => (0, endpoints_1.verifySupportingDocument)(input, opts));
|
|
115
115
|
}
|
|
116
|
+
/**
|
|
117
|
+
* Extract and validate a photo ID (passport, national ID, driving licence, PASS card,
|
|
118
|
+
* or unfamiliar photo ID), optionally face-matching against a supplied face scan.
|
|
119
|
+
* sub_types: Passport, NationalId, DrivingLicence, PASSCard, UnfamiliarPhotoId
|
|
120
|
+
*/
|
|
121
|
+
async verifyPhotoId(input) {
|
|
122
|
+
return this.withErrorHandling((opts) => (0, endpoints_1.verifyPhotoId)(input, opts));
|
|
123
|
+
}
|
|
116
124
|
}
|
|
117
125
|
exports.VouchsafeClient = VouchsafeClient;
|
|
118
126
|
//# sourceMappingURL=VouchsafeClient.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"VouchsafeClient.js","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"VouchsafeClient.js","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":";;;AAAA,mDAa4B,CAAC,mCAAmC;AAiBhE,MAAa,iBAAkB,SAAQ,KAAK;IAC1C,YACS,UAAkB,EAClB,YAAqB,EAC5B,OAAgB;QAEhB,KAAK,CAAC,OAAO,CAAC,CAAA;QAJP,eAAU,GAAV,UAAU,CAAQ;QAClB,iBAAY,GAAZ,YAAY,CAAS;QAI5B,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC;CACF;AATD,8CASC;AAED,MAAa,eAAe;IAI1B,YAAoB,OAA+B;QAA/B,YAAO,GAAP,OAAO,CAAwB;QAEnD;;WAEG;QAEK,mBAAc,GAAG,KAAK,IAAqB,EAAE;YACnD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;YACtB,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAA,CAAC,YAAY;YAE3C,IACE,IAAI,CAAC,KAAK;gBACV,IAAI,CAAC,WAAW;gBAChB,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,QAAQ,EACrD,CAAC;gBACD,OAAO,IAAI,CAAC,KAAM,CAAA;YACpB,CAAC;YAED,MAAM,QAAQ,GAAsB;gBAClC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;gBACjC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa;aAC1C,CAAA;YAED,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAY,EAAC,QAAQ,CAAC,CAAA;YAE7C,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,MAAM,IAAI,iBAAiB,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAA;YACtF,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC7D,MAAM,IAAI,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,EAAE,iDAAiD,CAAC,CAAA;YACpG,CAAC;YAED,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAA;YACvC,IAAI,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YAErD,OAAO,IAAI,CAAC,KAAK,CAAA;QACnB,CAAC,CAAA;QAED,yCAAyC;QACjC,gBAAW,GAAG,KAAK,IAA0B,EAAE;YACrD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA;YACzC,OAAO,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,EAAE,CAAA;QAC1D,CAAC,CAAA;QAED,6EAA6E;QACrE,sBAAiB,GAAG,KAAK,EAC/B,EAA6C,EACe,EAAE;YAG9D,MAAM,OAAO,GAAG,KAAK,IAAoB,EAAE;gBACzC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;gBACrC,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,CAAA;gBAE/B,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBACvD,OAAO,QAAQ,CAAC,IAAa,CAAA;gBAC/B,CAAC;gBAED,MAAM,IAAI,iBAAiB,CACzB,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,IAAI,EACZ,QAAQ,CAAC,IAAY,EAAE,OAAO,IAAI,8BAA8B,QAAQ,CAAC,MAAM,EAAE,CACnF,CAAA;YACH,CAAC,CAAA;YAED,IAAI,CAAC;gBACH,OAAO,MAAM,OAAO,EAAE,CAAA;YACxB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,GAAG,YAAY,iBAAiB,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;oBAC/D,qCAAqC;oBACrC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;oBACtB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;oBAC5B,OAAO,OAAO,EAAE,CAAA;gBAClB,CAAC;gBACD,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC,CAAA;IA7EqD,CAAC;IA+EvD;;OAEG;IAEH,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,EAAkB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,2BAAe,EAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;IACpE,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,MAAgC;QACtD,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,6BAAiB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;IAC1E,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,KAA+B;QACvD,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,+BAAmB,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IAC3E,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,KAAuB;QAC9C,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,8BAAkB,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IAC1E,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAwB;QACrD,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,0BAAc,EAAC,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;IAC7E,CAAC;IAED,KAAK,CAAC,SAAS;QACb,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAA;IAC1D,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAkB;QAClC,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,mBAAO,EAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;IAC5D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,EAAE,YAAY,EAA4B;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uBAAW,EAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAA;IAC1E,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,KAA6B;QAC7C,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,uBAAW,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IACnE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,wBAAwB,CAAC,KAAmC;QAChE,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,oCAAwB,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IAChF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,KAAwB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,yBAAa,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IACrE,CAAC;CACF;AAlJD,0CAkJC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vouchsafe/node",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.77",
|
|
4
4
|
"description": "Official TypeScript and Node.js library for the Vouchsafe identity platform. Use it for easy KYC checks, identity verification, remote right-to-work and more.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"vouchsafe",
|