@vouchsafe/node 0.1.40 → 0.1.43

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.
Files changed (66) hide show
  1. package/dist/VouchsafeClient.js +1 -1
  2. package/dist/VouchsafeClient.js.map +1 -1
  3. package/dist/openapi/apis/ArtefactsApi.d.ts +3 -3
  4. package/dist/openapi/apis/ArtefactsApi.d.ts.map +1 -1
  5. package/dist/openapi/apis/ArtefactsApi.js +4 -4
  6. package/dist/openapi/apis/ArtefactsApi.js.map +1 -1
  7. package/dist/openapi/apis/EVisaVerificationApi.d.ts +2 -2
  8. package/dist/openapi/apis/EVisaVerificationApi.js +2 -2
  9. package/dist/openapi/apis/FlowsApi.d.ts +4 -4
  10. package/dist/openapi/apis/FlowsApi.js +4 -4
  11. package/dist/openapi/apis/VerifyApi.d.ts +43 -0
  12. package/dist/openapi/apis/VerifyApi.d.ts.map +1 -0
  13. package/dist/openapi/apis/VerifyApi.js +152 -0
  14. package/dist/openapi/apis/VerifyApi.js.map +1 -0
  15. package/dist/openapi/apis/index.d.ts +1 -2
  16. package/dist/openapi/apis/index.d.ts.map +1 -1
  17. package/dist/openapi/apis/index.js +1 -2
  18. package/dist/openapi/apis/index.js.map +1 -1
  19. package/dist/openapi/models/EvisaExistsFailedReason.d.ts +26 -0
  20. package/dist/openapi/models/EvisaExistsFailedReason.d.ts.map +1 -0
  21. package/dist/openapi/models/EvisaExistsFailedReason.js +52 -0
  22. package/dist/openapi/models/EvisaExistsFailedReason.js.map +1 -0
  23. package/dist/openapi/models/EvisaExistsResult.d.ts +41 -0
  24. package/dist/openapi/models/EvisaExistsResult.d.ts.map +1 -0
  25. package/dist/openapi/models/EvisaExistsResult.js +55 -0
  26. package/dist/openapi/models/EvisaExistsResult.js.map +1 -0
  27. package/dist/openapi/models/EvisaNotExpiredFailedReason.d.ts +28 -0
  28. package/dist/openapi/models/EvisaNotExpiredFailedReason.d.ts.map +1 -0
  29. package/dist/openapi/models/EvisaNotExpiredFailedReason.js +54 -0
  30. package/dist/openapi/models/EvisaNotExpiredFailedReason.js.map +1 -0
  31. package/dist/openapi/models/EvisaNotExpiredResult.d.ts +41 -0
  32. package/dist/openapi/models/EvisaNotExpiredResult.d.ts.map +1 -0
  33. package/dist/openapi/models/EvisaNotExpiredResult.js +55 -0
  34. package/dist/openapi/models/EvisaNotExpiredResult.js.map +1 -0
  35. package/dist/openapi/models/EvisaRequiredFieldsExtractedFailedReason.d.ts +26 -0
  36. package/dist/openapi/models/EvisaRequiredFieldsExtractedFailedReason.d.ts.map +1 -0
  37. package/dist/openapi/models/EvisaRequiredFieldsExtractedFailedReason.js +52 -0
  38. package/dist/openapi/models/EvisaRequiredFieldsExtractedFailedReason.js.map +1 -0
  39. package/dist/openapi/models/EvisaRequiredFieldsExtractedResult.d.ts +41 -0
  40. package/dist/openapi/models/EvisaRequiredFieldsExtractedResult.d.ts.map +1 -0
  41. package/dist/openapi/models/EvisaRequiredFieldsExtractedResult.js +55 -0
  42. package/dist/openapi/models/EvisaRequiredFieldsExtractedResult.js.map +1 -0
  43. package/dist/openapi/models/EvisaStartedFailedReason.d.ts +27 -0
  44. package/dist/openapi/models/EvisaStartedFailedReason.d.ts.map +1 -0
  45. package/dist/openapi/models/EvisaStartedFailedReason.js +53 -0
  46. package/dist/openapi/models/EvisaStartedFailedReason.js.map +1 -0
  47. package/dist/openapi/models/EvisaStartedResult.d.ts +41 -0
  48. package/dist/openapi/models/EvisaStartedResult.d.ts.map +1 -0
  49. package/dist/openapi/models/EvisaStartedResult.js +55 -0
  50. package/dist/openapi/models/EvisaStartedResult.js.map +1 -0
  51. package/dist/openapi/models/EvisaValidations.d.ts +12 -9
  52. package/dist/openapi/models/EvisaValidations.d.ts.map +1 -1
  53. package/dist/openapi/models/EvisaValidations.js +12 -9
  54. package/dist/openapi/models/EvisaValidations.js.map +1 -1
  55. package/dist/openapi/models/ImmigrationStatusVerificationResponse.d.ts +1 -1
  56. package/dist/openapi/models/ImmigrationStatusVerificationResponseValidations.d.ts +12 -9
  57. package/dist/openapi/models/ImmigrationStatusVerificationResponseValidations.d.ts.map +1 -1
  58. package/dist/openapi/models/ImmigrationStatusVerificationResponseValidations.js +12 -9
  59. package/dist/openapi/models/ImmigrationStatusVerificationResponseValidations.js.map +1 -1
  60. package/dist/openapi/models/RightToRentVerificationResponse.d.ts +1 -1
  61. package/dist/openapi/models/RightToWorkVerificationResponse.d.ts +1 -1
  62. package/dist/openapi/models/index.d.ts +8 -0
  63. package/dist/openapi/models/index.d.ts.map +1 -1
  64. package/dist/openapi/models/index.js +8 -0
  65. package/dist/openapi/models/index.js.map +1 -1
  66. package/package.json +1 -1
@@ -120,7 +120,7 @@ class VouchsafeClient {
120
120
  * @returns Object with download_url, artefact_key, and expires_at
121
121
  */
122
122
  async getArtefact({ artefact_key }) {
123
- return this.withErrorHandling(() => this.artefactsApi.getArtefacts({ artefactKey: artefact_key }));
123
+ return this.withErrorHandling(() => this.artefactsApi.getArtefact({ artefactKey: artefact_key }));
124
124
  }
125
125
  /**
126
126
  * Verify a person's UK immigration status using their Home Office share code.
@@ -1 +1 @@
1
- {"version":3,"file":"VouchsafeClient.js","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":";;;AAAA,uCAAyC;AACzC,wEAAoE;AACpE,sEAAkE;AAClE,oEAAgE;AAChE,sDAAkD;AAClD,8DAA0D;AAC1D,8EAA0E;AAC1E,wGAAoG;AAgBpG,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;IAa1B,YAAoB,OAA+B;QAA/B,YAAO,GAAP,OAAO,CAAwB;QAiBnD;;;;WAIG;QAEH,sDAAsD;QAC9C,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,KAAK,CAAA;YACnB,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,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;gBACzD,iBAAiB,EAAE,QAAQ;aAC5B,CAAC,CAAA;YAEF,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,YAAY,CAAA;YAClC,IAAI,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YAEhD,OAAO,IAAI,CAAC,KAAK,CAAA;QACnB,CAAC,CAAA;QAED,0FAA0F;QAClF,sBAAiB,GAAG,KAAK,EAAK,EAAoB,EAAc,EAAE;YACxE,IAAI,CAAC;gBACH,OAAO,MAAM,EAAE,EAAE,CAAA;YACnB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,IAAI,GAAG,CAAC,QAAQ,YAAY,QAAQ,EAAE,CAAC;oBACrE,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;wBAChC,uCAAuC;wBACvC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;wBACtB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;wBAC5B,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA;wBAE3B,OAAO,EAAE,EAAE,CAAA;oBACb,CAAC;oBAED,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;oBACxD,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAA;oBACxD,MAAM,IAAI,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;gBACjE,CAAC;gBAED,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC,CAAA;QAxEC,MAAM,QAAQ,GAAG,iCAAiC,CAAA;QAElD,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAa,CAAC;YAC9B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,cAAc;SACjC,CAAC,CAAA;QAEF,IAAI,CAAC,iBAAiB,GAAG,IAAI,qCAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,eAAe,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACjD,IAAI,CAAC,oBAAoB,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACjE,IAAI,CAAC,iCAAiC,GAAG,IAAI,qEAAiC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC7F,CAAC;IA4DD;;;;OAIG;IAEH,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,EAAkB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,CAAC,CAC9C,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAE,MAAM,KAA0B,EAAE;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,CACpD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,KAA+B;QACvD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC;YACxC,wBAAwB,EAAE,KAAK;SAChC,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,KAAuB;QAC9C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC;YACtC,gBAAgB,EAAE,KAAK;SACxB,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAwB;QACrD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC,CAClD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,SAAS;QACb,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CACxD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAkB;QAClC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAC5D,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,WAAW,CAAC,EAAE,YAAY,EAA4B;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,CAC9D,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,WAAW,CAAC,KAA6B;QAC7C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE,sBAAsB,EAAE,KAAK,EAAE,CAAC,CACzE,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,wBAAwB,CAAC,MAI9B;QACC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iCAAiC,CAAC,wBAAwB,CAAC;YAC9D,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,OAAO,EAAE,MAAM,CAAC,QAAQ;YACxB,qBAAqB,EAAE,MAAM,CAAC,uBAAuB,EAAE,QAAQ,EAAE;SAClE,CAAC,CACH,CAAA;IACH,CAAC;CACF;AA5MD,0CA4MC"}
1
+ {"version":3,"file":"VouchsafeClient.js","sourceRoot":"","sources":["../src/VouchsafeClient.ts"],"names":[],"mappings":";;;AAAA,uCAAyC;AACzC,wEAAoE;AACpE,sEAAkE;AAClE,oEAAgE;AAChE,sDAAkD;AAClD,8DAA0D;AAC1D,8EAA0E;AAC1E,wGAAoG;AAgBpG,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;IAa1B,YAAoB,OAA+B;QAA/B,YAAO,GAAP,OAAO,CAAwB;QAiBnD;;;;WAIG;QAEH,sDAAsD;QAC9C,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,KAAK,CAAA;YACnB,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,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;gBACzD,iBAAiB,EAAE,QAAQ;aAC5B,CAAC,CAAA;YAEF,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,YAAY,CAAA;YAClC,IAAI,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YAEhD,OAAO,IAAI,CAAC,KAAK,CAAA;QACnB,CAAC,CAAA;QAED,0FAA0F;QAClF,sBAAiB,GAAG,KAAK,EAAK,EAAoB,EAAc,EAAE;YACxE,IAAI,CAAC;gBACH,OAAO,MAAM,EAAE,EAAE,CAAA;YACnB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,IAAI,GAAG,CAAC,QAAQ,YAAY,QAAQ,EAAE,CAAC;oBACrE,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;wBAChC,uCAAuC;wBACvC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;wBACtB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;wBAC5B,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA;wBAE3B,OAAO,EAAE,EAAE,CAAA;oBACb,CAAC;oBAED,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;oBACxD,MAAM,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAA;oBACxD,MAAM,IAAI,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;gBACjE,CAAC;gBAED,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC,CAAA;QAxEC,MAAM,QAAQ,GAAG,iCAAiC,CAAA;QAElD,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAa,CAAC;YAC9B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,cAAc;SACjC,CAAC,CAAA;QAEF,IAAI,CAAC,iBAAiB,GAAG,IAAI,qCAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC3D,IAAI,CAAC,gBAAgB,GAAG,IAAI,mCAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,eAAe,GAAG,IAAI,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACjD,IAAI,CAAC,oBAAoB,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACjE,IAAI,CAAC,iCAAiC,GAAG,IAAI,qEAAiC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC7F,CAAC;IA4DD;;;;OAIG;IAEH,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,EAAkB;QAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,EAAE,EAAE,EAAE,CAAC,CAC9C,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAE,MAAM,KAA0B,EAAE;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,CACpD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,KAA+B;QACvD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC;YACxC,wBAAwB,EAAE,KAAK;SAChC,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,KAAuB;QAC9C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC;YACtC,gBAAgB,EAAE,KAAK;SACxB,CAAC,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAwB;QACrD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC,CAClD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,SAAS;QACb,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CACxD,CAAA;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAkB;QAClC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAC5D,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,WAAW,CAAC,EAAE,YAAY,EAA4B;QAC1D,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,CAC7D,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,WAAW,CAAC,KAA6B;QAC7C,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE,sBAAsB,EAAE,KAAK,EAAE,CAAC,CACzE,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,wBAAwB,CAAC,MAI9B;QACC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,CACjC,IAAI,CAAC,iCAAiC,CAAC,wBAAwB,CAAC;YAC9D,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,OAAO,EAAE,MAAM,CAAC,QAAQ;YACxB,qBAAqB,EAAE,MAAM,CAAC,uBAAuB,EAAE,QAAQ,EAAE;SAClE,CAAC,CACH,CAAA;IACH,CAAC;CACF;AA5MD,0CA4MC"}
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import * as runtime from '../runtime';
13
13
  import type { GetArtefactsResponse } from '../models/index';
14
- export interface GetArtefactsRequest {
14
+ export interface GetArtefactRequest {
15
15
  artefactKey: string;
16
16
  }
17
17
  /**
@@ -21,10 +21,10 @@ export declare class ArtefactsApi extends runtime.BaseAPI {
21
21
  /**
22
22
  * Get an artefact download link. For security reasons, other endpoints (e.g. `GET /verifications/{id}`) may return only an `artefact_key`. Use this endpoint to exchange that key for a **time-limited pre-signed URL** that can be used to download the file. Vouchsafe will respond with: - the requested `artefact_key` - a `download_url` (pre-signed and time-limited) - an `expires_at` timestamp (ISO 8601, UTC) **Note:** The `download_url` will stop working after `expires_at`. If it expires, request a new URL using this endpoint.
23
23
  */
24
- getArtefactsRaw(requestParameters: GetArtefactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetArtefactsResponse>>;
24
+ getArtefactRaw(requestParameters: GetArtefactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetArtefactsResponse>>;
25
25
  /**
26
26
  * Get an artefact download link. For security reasons, other endpoints (e.g. `GET /verifications/{id}`) may return only an `artefact_key`. Use this endpoint to exchange that key for a **time-limited pre-signed URL** that can be used to download the file. Vouchsafe will respond with: - the requested `artefact_key` - a `download_url` (pre-signed and time-limited) - an `expires_at` timestamp (ISO 8601, UTC) **Note:** The `download_url` will stop working after `expires_at`. If it expires, request a new URL using this endpoint.
27
27
  */
28
- getArtefacts(requestParameters: GetArtefactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetArtefactsResponse>;
28
+ getArtefact(requestParameters: GetArtefactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetArtefactsResponse>;
29
29
  }
30
30
  //# sourceMappingURL=ArtefactsApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ArtefactsApi.d.ts","sourceRoot":"","sources":["../../../src/openapi/apis/ArtefactsApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAEV,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AAQzB,MAAM,WAAW,mBAAmB;IAChC,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,OAAO,CAAC,OAAO;IAE7C;;OAEG;IACG,eAAe,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAkC7K;;OAEG;IACG,YAAY,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAKxJ"}
1
+ {"version":3,"file":"ArtefactsApi.d.ts","sourceRoot":"","sources":["../../../src/openapi/apis/ArtefactsApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAEV,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AAQzB,MAAM,WAAW,kBAAkB;IAC/B,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,OAAO,CAAC,OAAO;IAE7C;;OAEG;IACG,cAAc,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAkC3K;;OAEG;IACG,WAAW,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAKtJ"}
@@ -56,9 +56,9 @@ class ArtefactsApi extends runtime.BaseAPI {
56
56
  /**
57
57
  * Get an artefact download link. For security reasons, other endpoints (e.g. `GET /verifications/{id}`) may return only an `artefact_key`. Use this endpoint to exchange that key for a **time-limited pre-signed URL** that can be used to download the file. Vouchsafe will respond with: - the requested `artefact_key` - a `download_url` (pre-signed and time-limited) - an `expires_at` timestamp (ISO 8601, UTC) **Note:** The `download_url` will stop working after `expires_at`. If it expires, request a new URL using this endpoint.
58
58
  */
59
- async getArtefactsRaw(requestParameters, initOverrides) {
59
+ async getArtefactRaw(requestParameters, initOverrides) {
60
60
  if (requestParameters['artefactKey'] == null) {
61
- throw new runtime.RequiredError('artefactKey', 'Required parameter "artefactKey" was null or undefined when calling getArtefacts().');
61
+ throw new runtime.RequiredError('artefactKey', 'Required parameter "artefactKey" was null or undefined when calling getArtefact().');
62
62
  }
63
63
  const queryParameters = {};
64
64
  const headerParameters = {};
@@ -82,8 +82,8 @@ class ArtefactsApi extends runtime.BaseAPI {
82
82
  /**
83
83
  * Get an artefact download link. For security reasons, other endpoints (e.g. `GET /verifications/{id}`) may return only an `artefact_key`. Use this endpoint to exchange that key for a **time-limited pre-signed URL** that can be used to download the file. Vouchsafe will respond with: - the requested `artefact_key` - a `download_url` (pre-signed and time-limited) - an `expires_at` timestamp (ISO 8601, UTC) **Note:** The `download_url` will stop working after `expires_at`. If it expires, request a new URL using this endpoint.
84
84
  */
85
- async getArtefacts(requestParameters, initOverrides) {
86
- const response = await this.getArtefactsRaw(requestParameters, initOverrides);
85
+ async getArtefact(requestParameters, initOverrides) {
86
+ const response = await this.getArtefactRaw(requestParameters, initOverrides);
87
87
  return await response.value();
88
88
  }
89
89
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ArtefactsApi.js","sourceRoot":"","sources":["../../../src/openapi/apis/ArtefactsApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,oDAAsC;AAKtC,2CAKyB;AAMzB;;GAEG;AACH,MAAa,YAAa,SAAQ,OAAO,CAAC,OAAO;IAE7C;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,iBAAsC,EAAE,aAA0D;QACpH,IAAI,iBAAiB,CAAC,aAAa,CAAC,IAAI,IAAI,EAAE,CAAC;YAC3C,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,aAAa,EACb,qFAAqF,CACxF,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,2BAA2B,CAAC;QAC1C,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,cAAc,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,oCAA4B,EAAC,SAAS,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,iBAAsC,EAAE,aAA0D;QACjH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC9E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AA/CD,oCA+CC"}
1
+ {"version":3,"file":"ArtefactsApi.js","sourceRoot":"","sources":["../../../src/openapi/apis/ArtefactsApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,oDAAsC;AAKtC,2CAKyB;AAMzB;;GAEG;AACH,MAAa,YAAa,SAAQ,OAAO,CAAC,OAAO;IAE7C;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,iBAAqC,EAAE,aAA0D;QAClH,IAAI,iBAAiB,CAAC,aAAa,CAAC,IAAI,IAAI,EAAE,CAAC;YAC3C,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,aAAa,EACb,oFAAoF,CACvF,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,2BAA2B,CAAC;QAC1C,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,cAAc,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,oCAA4B,EAAC,SAAS,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,iBAAqC,EAAE,aAA0D;QAC/G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC7E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AA/CD,oCA+CC"}
@@ -19,11 +19,11 @@ export interface VerifyEvisaRequest {
19
19
  */
20
20
  export declare class EVisaVerificationApi extends runtime.BaseAPI {
21
21
  /**
22
- * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Billing:** Every successful API call (`HTTP 200`) is a billable event, regardless of whether the verification outcome is `pass` or `fail`. Error responses (`HTTP 422`, `HTTP 503`) are not billable and return a different response body. Note that the `billable` field in the response is deprecated and will always be `true` on a `HTTP 200` response. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Retry guidance:** It is safe to retry requests as the endpoint is stateless and does not create persistent records. We recommend an exponential backoff strategy (e.g. 2s, 4s, 8s) with a maximum of 2–3 retries for transient failures (`HTTP 503`). Do **not** retry `HTTP 422` responses as these indicate the share code has been locked out by GOV.UK and the user needs to generate a new one. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
22
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Response summary:** | HTTP Status | Meaning | Action | |-------------|---------|--------| | `200` | Verification completed | Check the `outcome` field to determine if the verification was successful | | `422` | Share code locked out by GOV.UK | Retry with a new share code | | `503` | Service temporarily unavailable | Retry with exponential backoff | **Billing:** An API call is billable when the eVisa was found on GOV.UK, regardless of whether the verification outcome is `pass` or `fail`. If the `share_code` or `date_of_birth` is invalid and no eVisa can be retrieved, the response will have `billable: false` and you will not be charged. Error responses (`HTTP 422`, `HTTP 503`) are also not billable and return an Error response body. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response - `BADCODE12` - Returns a non-billable failed verification (e.g. invalid share code) - `WRONGDOB1` - Returns a non-billable failed verification (e.g. wrong date of birth) > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
23
23
  */
24
24
  verifyEvisaRaw(requestParameters: VerifyEvisaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvisaVerificationResponse>>;
25
25
  /**
26
- * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Billing:** Every successful API call (`HTTP 200`) is a billable event, regardless of whether the verification outcome is `pass` or `fail`. Error responses (`HTTP 422`, `HTTP 503`) are not billable and return a different response body. Note that the `billable` field in the response is deprecated and will always be `true` on a `HTTP 200` response. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Retry guidance:** It is safe to retry requests as the endpoint is stateless and does not create persistent records. We recommend an exponential backoff strategy (e.g. 2s, 4s, 8s) with a maximum of 2–3 retries for transient failures (`HTTP 503`). Do **not** retry `HTTP 422` responses as these indicate the share code has been locked out by GOV.UK and the user needs to generate a new one. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
26
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Response summary:** | HTTP Status | Meaning | Action | |-------------|---------|--------| | `200` | Verification completed | Check the `outcome` field to determine if the verification was successful | | `422` | Share code locked out by GOV.UK | Retry with a new share code | | `503` | Service temporarily unavailable | Retry with exponential backoff | **Billing:** An API call is billable when the eVisa was found on GOV.UK, regardless of whether the verification outcome is `pass` or `fail`. If the `share_code` or `date_of_birth` is invalid and no eVisa can be retrieved, the response will have `billable: false` and you will not be charged. Error responses (`HTTP 422`, `HTTP 503`) are also not billable and return an Error response body. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response - `BADCODE12` - Returns a non-billable failed verification (e.g. invalid share code) - `WRONGDOB1` - Returns a non-billable failed verification (e.g. wrong date of birth) > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
27
27
  */
28
28
  verifyEvisa(requestParameters: VerifyEvisaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvisaVerificationResponse>;
29
29
  }
@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
54
54
  */
55
55
  class EVisaVerificationApi extends runtime.BaseAPI {
56
56
  /**
57
- * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Billing:** Every successful API call (`HTTP 200`) is a billable event, regardless of whether the verification outcome is `pass` or `fail`. Error responses (`HTTP 422`, `HTTP 503`) are not billable and return a different response body. Note that the `billable` field in the response is deprecated and will always be `true` on a `HTTP 200` response. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Retry guidance:** It is safe to retry requests as the endpoint is stateless and does not create persistent records. We recommend an exponential backoff strategy (e.g. 2s, 4s, 8s) with a maximum of 2–3 retries for transient failures (`HTTP 503`). Do **not** retry `HTTP 422` responses as these indicate the share code has been locked out by GOV.UK and the user needs to generate a new one. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
57
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Response summary:** | HTTP Status | Meaning | Action | |-------------|---------|--------| | `200` | Verification completed | Check the `outcome` field to determine if the verification was successful | | `422` | Share code locked out by GOV.UK | Retry with a new share code | | `503` | Service temporarily unavailable | Retry with exponential backoff | **Billing:** An API call is billable when the eVisa was found on GOV.UK, regardless of whether the verification outcome is `pass` or `fail`. If the `share_code` or `date_of_birth` is invalid and no eVisa can be retrieved, the response will have `billable: false` and you will not be charged. Error responses (`HTTP 422`, `HTTP 503`) are also not billable and return an Error response body. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response - `BADCODE12` - Returns a non-billable failed verification (e.g. invalid share code) - `WRONGDOB1` - Returns a non-billable failed verification (e.g. wrong date of birth) > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
58
58
  */
59
59
  async verifyEvisaRaw(requestParameters, initOverrides) {
60
60
  if (requestParameters['evisaVerificationInput'] == null) {
@@ -81,7 +81,7 @@ class EVisaVerificationApi extends runtime.BaseAPI {
81
81
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EvisaVerificationResponseFromJSON)(jsonValue));
82
82
  }
83
83
  /**
84
- * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Billing:** Every successful API call (`HTTP 200`) is a billable event, regardless of whether the verification outcome is `pass` or `fail`. Error responses (`HTTP 422`, `HTTP 503`) are not billable and return a different response body. Note that the `billable` field in the response is deprecated and will always be `true` on a `HTTP 200` response. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Retry guidance:** It is safe to retry requests as the endpoint is stateless and does not create persistent records. We recommend an exponential backoff strategy (e.g. 2s, 4s, 8s) with a maximum of 2–3 retries for transient failures (`HTTP 503`). Do **not** retry `HTTP 422` responses as these indicate the share code has been locked out by GOV.UK and the user needs to generate a new one. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
84
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Response summary:** | HTTP Status | Meaning | Action | |-------------|---------|--------| | `200` | Verification completed | Check the `outcome` field to determine if the verification was successful | | `422` | Share code locked out by GOV.UK | Retry with a new share code | | `503` | Service temporarily unavailable | Retry with exponential backoff | **Billing:** An API call is billable when the eVisa was found on GOV.UK, regardless of whether the verification outcome is `pass` or `fail`. If the `share_code` or `date_of_birth` is invalid and no eVisa can be retrieved, the response will have `billable: false` and you will not be charged. Error responses (`HTTP 422`, `HTTP 503`) are also not billable and return an Error response body. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response - `BADCODE12` - Returns a non-billable failed verification (e.g. invalid share code) - `WRONGDOB1` - Returns a non-billable failed verification (e.g. wrong date of birth) > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
85
85
  */
86
86
  async verifyEvisa(requestParameters, initOverrides) {
87
87
  const response = await this.verifyEvisaRaw(requestParameters, initOverrides);
@@ -19,19 +19,19 @@ export interface GetFlowRequest {
19
19
  */
20
20
  export declare class FlowsApi extends runtime.BaseAPI {
21
21
  /**
22
- * Get a specific verification flow. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://localhost:3000/docs/operations/RequestVerification). > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
22
+ * Get a specific verification flow. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://app.vouchsafe.id/docs/operations/RequestVerification). > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
23
23
  */
24
24
  getFlowRaw(requestParameters: GetFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Flow>>;
25
25
  /**
26
- * Get a specific verification flow. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://localhost:3000/docs/operations/RequestVerification). > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
26
+ * Get a specific verification flow. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://app.vouchsafe.id/docs/operations/RequestVerification). > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
27
27
  */
28
28
  getFlow(requestParameters: GetFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Flow>;
29
29
  /**
30
- * Get a list of all the currently published verification flows. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://localhost:3000/docs/operations/RequestVerification). Referee-specific verification flows cannot be started independently, so are not returned by this endpoint. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
30
+ * Get a list of all the currently published verification flows. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://app.vouchsafe.id/docs/operations/RequestVerification). Referee-specific verification flows cannot be started independently, so are not returned by this endpoint. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
31
31
  */
32
32
  listFlowsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Flow>>>;
33
33
  /**
34
- * Get a list of all the currently published verification flows. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://localhost:3000/docs/operations/RequestVerification). Referee-specific verification flows cannot be started independently, so are not returned by this endpoint. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
34
+ * Get a list of all the currently published verification flows. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://app.vouchsafe.id/docs/operations/RequestVerification). Referee-specific verification flows cannot be started independently, so are not returned by this endpoint. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
35
35
  */
36
36
  listFlows(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Flow>>;
37
37
  }
@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
54
54
  */
55
55
  class FlowsApi extends runtime.BaseAPI {
56
56
  /**
57
- * Get a specific verification flow. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://localhost:3000/docs/operations/RequestVerification). > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
57
+ * Get a specific verification flow. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://app.vouchsafe.id/docs/operations/RequestVerification). > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
58
58
  */
59
59
  async getFlowRaw(requestParameters, initOverrides) {
60
60
  if (requestParameters['id'] == null) {
@@ -80,14 +80,14 @@ class FlowsApi extends runtime.BaseAPI {
80
80
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FlowFromJSON)(jsonValue));
81
81
  }
82
82
  /**
83
- * Get a specific verification flow. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://localhost:3000/docs/operations/RequestVerification). > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
83
+ * Get a specific verification flow. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://app.vouchsafe.id/docs/operations/RequestVerification). > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
84
84
  */
85
85
  async getFlow(requestParameters, initOverrides) {
86
86
  const response = await this.getFlowRaw(requestParameters, initOverrides);
87
87
  return await response.value();
88
88
  }
89
89
  /**
90
- * Get a list of all the currently published verification flows. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://localhost:3000/docs/operations/RequestVerification). Referee-specific verification flows cannot be started independently, so are not returned by this endpoint. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
90
+ * Get a list of all the currently published verification flows. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://app.vouchsafe.id/docs/operations/RequestVerification). Referee-specific verification flows cannot be started independently, so are not returned by this endpoint. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
91
91
  */
92
92
  async listFlowsRaw(initOverrides) {
93
93
  const queryParameters = {};
@@ -109,7 +109,7 @@ class FlowsApi extends runtime.BaseAPI {
109
109
  return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.FlowFromJSON));
110
110
  }
111
111
  /**
112
- * Get a list of all the currently published verification flows. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://localhost:3000/docs/operations/RequestVerification). Referee-specific verification flows cannot be started independently, so are not returned by this endpoint. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
112
+ * Get a list of all the currently published verification flows. Use an ID from one of these flows to request verifications with the [`POST /verifications` endpoint](https://app.vouchsafe.id/docs/operations/RequestVerification). Referee-specific verification flows cannot be started independently, so are not returned by this endpoint. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
113
113
  */
114
114
  async listFlows(initOverrides) {
115
115
  const response = await this.listFlowsRaw(initOverrides);
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Vouchsafe API docs
3
+ * Vouchsafe offers a REST API to conduct operations programmatically. You can request and manage verifications, as well as perform smart lookups. To use the API, you need a client ID and secret from the Vouchsafe dashboard. [Sign up here](https://app.vouchsafe.id/) if you haven\'t already. We also have a [video guide](https://www.youtube.com/playlist?list=PLx6V6SSTMuF_ZNWBPnysvwmdIwboLViE8) showing the basics, as well as [SDKs and libraries](https://help.vouchsafe.id/en/articles/12026847-vouchsafe-sdks-and-libraries) for popular languages.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ * Contact: help@vouchsafe.id
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { EvisaVerificationInput, EvisaVerificationResponse, SupportingDocumentVerificationResponse } from '../models/index';
14
+ export interface VerifyEvisaRequest {
15
+ evisaVerificationInput: EvisaVerificationInput;
16
+ }
17
+ export interface VerifySupportingDocumentRequest {
18
+ document: Blob;
19
+ subType: string;
20
+ minimumDocumentLength?: string;
21
+ }
22
+ /**
23
+ *
24
+ */
25
+ export declare class VerifyApi extends runtime.BaseAPI {
26
+ /**
27
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Response summary:** | HTTP Status | Meaning | Action | |-------------|---------|--------| | `200` | Verification completed | Check the `outcome` field to determine if the verification was successful | | `422` | Share code locked out by GOV.UK | Retry with a new share code | | `503` | Service temporarily unavailable | Retry with exponential backoff | **Billing:** An API call is billable when the eVisa was found on GOV.UK, regardless of whether the verification outcome is `pass` or `fail`. If the `share_code` or `date_of_birth` is invalid and no eVisa can be retrieved, the response will have `billable: false` and you will not be charged. Error responses (`HTTP 422`, `HTTP 503`) are also not billable and return an Error response body. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response - `BADCODE12` - Returns a non-billable failed verification (e.g. invalid share code) - `WRONGDOB1` - Returns a non-billable failed verification (e.g. wrong date of birth) > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
28
+ */
29
+ verifyEvisaRaw(requestParameters: VerifyEvisaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EvisaVerificationResponse>>;
30
+ /**
31
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Response summary:** | HTTP Status | Meaning | Action | |-------------|---------|--------| | `200` | Verification completed | Check the `outcome` field to determine if the verification was successful | | `422` | Share code locked out by GOV.UK | Retry with a new share code | | `503` | Service temporarily unavailable | Retry with exponential backoff | **Billing:** An API call is billable when the eVisa was found on GOV.UK, regardless of whether the verification outcome is `pass` or `fail`. If the `share_code` or `date_of_birth` is invalid and no eVisa can be retrieved, the response will have `billable: false` and you will not be charged. Error responses (`HTTP 422`, `HTTP 503`) are also not billable and return an Error response body. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response - `BADCODE12` - Returns a non-billable failed verification (e.g. invalid share code) - `WRONGDOB1` - Returns a non-billable failed verification (e.g. wrong date of birth) > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
32
+ */
33
+ verifyEvisa(requestParameters: VerifyEvisaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EvisaVerificationResponse>;
34
+ /**
35
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Extract and validate a supporting document. This endpoint accepts a document file (PDF, JPG, or PNG) and extracts personal identity information and address details. **Request format:** This endpoint accepts `multipart/form-data` with: - `document` - The document file (PDF, JPG, or PNG, max 10MB) - `sub_type` (required) - The type of document (e.g., `BankStatement`, `UtilityBill`). See \"Supported document types\" below. - `minimum_document_length` (optional) - Minimum document age in months. Documents older than this will fail the `document_age_valid` check. **Supported document types (`sub_type`):** - `Payslip` - Employment payslips - `PensionAnnualStatement` - Pension statements - `BenefitsLetter` - Government benefits letters - `HMPPSLetter` - Probation service letters - `NHSLetter` - NHS correspondence - `BankStatement` - Bank account statements - `CreditCardStatement` - Credit card statements - `MortgageStatement` - Mortgage statements - `UtilityBill` - Gas, electricity, water bills - `MobilePhoneBill` - Mobile phone bills **Validations performed:** - `required_fields_extracted` - Key identity fields were successfully extracted. These are: `first_name`, `last_name`, `first_line_of_address` and `postcode` - `category_match` - Document matches the specified sub_type - `document_age_valid` - Document is within acceptable age range (only if `minimum_document_length` provided) - `document_complete_and_legible` - Document is complete and readable - `tampering_signals_check` - No signs of document tampering detected Sandbox testing: In sandbox mode, the endpoint returns a mock \"pass\" response with sandbox values. No actual document processing occurs. > **Request behaviour:** This is a synchronous endpoint. Processing typically takes 5-15 seconds > depending on document complexity. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
36
+ */
37
+ verifySupportingDocumentRaw(requestParameters: VerifySupportingDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SupportingDocumentVerificationResponse>>;
38
+ /**
39
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Extract and validate a supporting document. This endpoint accepts a document file (PDF, JPG, or PNG) and extracts personal identity information and address details. **Request format:** This endpoint accepts `multipart/form-data` with: - `document` - The document file (PDF, JPG, or PNG, max 10MB) - `sub_type` (required) - The type of document (e.g., `BankStatement`, `UtilityBill`). See \"Supported document types\" below. - `minimum_document_length` (optional) - Minimum document age in months. Documents older than this will fail the `document_age_valid` check. **Supported document types (`sub_type`):** - `Payslip` - Employment payslips - `PensionAnnualStatement` - Pension statements - `BenefitsLetter` - Government benefits letters - `HMPPSLetter` - Probation service letters - `NHSLetter` - NHS correspondence - `BankStatement` - Bank account statements - `CreditCardStatement` - Credit card statements - `MortgageStatement` - Mortgage statements - `UtilityBill` - Gas, electricity, water bills - `MobilePhoneBill` - Mobile phone bills **Validations performed:** - `required_fields_extracted` - Key identity fields were successfully extracted. These are: `first_name`, `last_name`, `first_line_of_address` and `postcode` - `category_match` - Document matches the specified sub_type - `document_age_valid` - Document is within acceptable age range (only if `minimum_document_length` provided) - `document_complete_and_legible` - Document is complete and readable - `tampering_signals_check` - No signs of document tampering detected Sandbox testing: In sandbox mode, the endpoint returns a mock \"pass\" response with sandbox values. No actual document processing occurs. > **Request behaviour:** This is a synchronous endpoint. Processing typically takes 5-15 seconds > depending on document complexity. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
40
+ */
41
+ verifySupportingDocument(requestParameters: VerifySupportingDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SupportingDocumentVerificationResponse>;
42
+ }
43
+ //# sourceMappingURL=VerifyApi.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"VerifyApi.d.ts","sourceRoot":"","sources":["../../../src/openapi/apis/VerifyApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAEV,sBAAsB,EACtB,yBAAyB,EACzB,sCAAsC,EACvC,MAAM,iBAAiB,CAAC;AAYzB,MAAM,WAAW,kBAAkB;IAC/B,sBAAsB,EAAE,sBAAsB,CAAC;CAClD;AAED,MAAM,WAAW,+BAA+B;IAC5C,QAAQ,EAAE,IAAI,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,OAAO,CAAC,OAAO;IAE1C;;OAEG;IACG,cAAc,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAoChL;;OAEG;IACG,WAAW,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAKxJ;;OAEG;IACG,2BAA2B,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,sCAAsC,CAAC,CAAC;IAqEvN;;OAEG;IACG,wBAAwB,CAAC,iBAAiB,EAAE,+BAA+B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,sCAAsC,CAAC;CAKlM"}
@@ -0,0 +1,152 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Vouchsafe API docs
6
+ * Vouchsafe offers a REST API to conduct operations programmatically. You can request and manage verifications, as well as perform smart lookups. To use the API, you need a client ID and secret from the Vouchsafe dashboard. [Sign up here](https://app.vouchsafe.id/) if you haven\'t already. We also have a [video guide](https://www.youtube.com/playlist?list=PLx6V6SSTMuF_ZNWBPnysvwmdIwboLViE8) showing the basics, as well as [SDKs and libraries](https://help.vouchsafe.id/en/articles/12026847-vouchsafe-sdks-and-libraries) for popular languages.
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ * Contact: help@vouchsafe.id
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
16
+ if (k2 === undefined) k2 = k;
17
+ var desc = Object.getOwnPropertyDescriptor(m, k);
18
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
19
+ desc = { enumerable: true, get: function() { return m[k]; } };
20
+ }
21
+ Object.defineProperty(o, k2, desc);
22
+ }) : (function(o, m, k, k2) {
23
+ if (k2 === undefined) k2 = k;
24
+ o[k2] = m[k];
25
+ }));
26
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
27
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
28
+ }) : function(o, v) {
29
+ o["default"] = v;
30
+ });
31
+ var __importStar = (this && this.__importStar) || (function () {
32
+ var ownKeys = function(o) {
33
+ ownKeys = Object.getOwnPropertyNames || function (o) {
34
+ var ar = [];
35
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
36
+ return ar;
37
+ };
38
+ return ownKeys(o);
39
+ };
40
+ return function (mod) {
41
+ if (mod && mod.__esModule) return mod;
42
+ var result = {};
43
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
44
+ __setModuleDefault(result, mod);
45
+ return result;
46
+ };
47
+ })();
48
+ Object.defineProperty(exports, "__esModule", { value: true });
49
+ exports.VerifyApi = void 0;
50
+ const runtime = __importStar(require("../runtime"));
51
+ const index_1 = require("../models/index");
52
+ /**
53
+ *
54
+ */
55
+ class VerifyApi extends runtime.BaseAPI {
56
+ /**
57
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Response summary:** | HTTP Status | Meaning | Action | |-------------|---------|--------| | `200` | Verification completed | Check the `outcome` field to determine if the verification was successful | | `422` | Share code locked out by GOV.UK | Retry with a new share code | | `503` | Service temporarily unavailable | Retry with exponential backoff | **Billing:** An API call is billable when the eVisa was found on GOV.UK, regardless of whether the verification outcome is `pass` or `fail`. If the `share_code` or `date_of_birth` is invalid and no eVisa can be retrieved, the response will have `billable: false` and you will not be charged. Error responses (`HTTP 422`, `HTTP 503`) are also not billable and return an Error response body. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response - `BADCODE12` - Returns a non-billable failed verification (e.g. invalid share code) - `WRONGDOB1` - Returns a non-billable failed verification (e.g. wrong date of birth) > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
58
+ */
59
+ async verifyEvisaRaw(requestParameters, initOverrides) {
60
+ if (requestParameters['evisaVerificationInput'] == null) {
61
+ throw new runtime.RequiredError('evisaVerificationInput', 'Required parameter "evisaVerificationInput" was null or undefined when calling verifyEvisa().');
62
+ }
63
+ const queryParameters = {};
64
+ const headerParameters = {};
65
+ headerParameters['Content-Type'] = 'application/json';
66
+ if (this.configuration && this.configuration.accessToken) {
67
+ const token = this.configuration.accessToken;
68
+ const tokenString = await token("bearerAuth", []);
69
+ if (tokenString) {
70
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
71
+ }
72
+ }
73
+ let urlPath = `/verify/evisa`;
74
+ const response = await this.request({
75
+ path: urlPath,
76
+ method: 'POST',
77
+ headers: headerParameters,
78
+ query: queryParameters,
79
+ body: (0, index_1.EvisaVerificationInputToJSON)(requestParameters['evisaVerificationInput']),
80
+ }, initOverrides);
81
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EvisaVerificationResponseFromJSON)(jsonValue));
82
+ }
83
+ /**
84
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Verify a person\'s UK eVisa using their Home Office share code. This endpoint allows you to verify a person\'s `immigration status`, `right to work`, or `right to rent` eVisa by providing their share code and date of birth. The share code is obtained by the individual from the UK Home Office online service. **Supported verification types:** - `ImmigrationStatus` - Check a person\'s immigration status (e.g., Settled, Skilled Worker, Youth Mobility Scheme) - `RightToWork` - Check a person\'s right to work in the UK - `RightToRent` - Check a person\'s right to rent property in the UK > **Request behaviour:** This is a synchronous endpoint. It can take up to 20 seconds. **Response fields by sub-type:** The response fields directly reflect the information available on a particular eVisa sub-type. On a `pass` outcome, all fields for the sub-type will be populated. On a `fail` outcome, `extracted_details` may be partially populated or empty depending on which validation step failed. **Response summary:** | HTTP Status | Meaning | Action | |-------------|---------|--------| | `200` | Verification completed | Check the `outcome` field to determine if the verification was successful | | `422` | Share code locked out by GOV.UK | Retry with a new share code | | `503` | Service temporarily unavailable | Retry with exponential backoff | **Billing:** An API call is billable when the eVisa was found on GOV.UK, regardless of whether the verification outcome is `pass` or `fail`. If the `share_code` or `date_of_birth` is invalid and no eVisa can be retrieved, the response will have `billable: false` and you will not be charged. Error responses (`HTTP 422`, `HTTP 503`) are also not billable and return an Error response body. **Artefacts:** On a successful response, artefacts are returned inline with pre-signed download URLs. You have **30 minutes** to download them before the URLs expire. **Sandbox testing:** Use these share codes in sandbox mode to test different outcomes: - `PASS12345` - Returns a successful verification with \"Pass\" outcome - `FAIL12345` - Returns a failed verification (e.g. expired status) - `ERROR1234` - Returns an error response - `BADCODE12` - Returns a non-billable failed verification (e.g. invalid share code) - `WRONGDOB1` - Returns a non-billable failed verification (e.g. wrong date of birth) > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
85
+ */
86
+ async verifyEvisa(requestParameters, initOverrides) {
87
+ const response = await this.verifyEvisaRaw(requestParameters, initOverrides);
88
+ return await response.value();
89
+ }
90
+ /**
91
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Extract and validate a supporting document. This endpoint accepts a document file (PDF, JPG, or PNG) and extracts personal identity information and address details. **Request format:** This endpoint accepts `multipart/form-data` with: - `document` - The document file (PDF, JPG, or PNG, max 10MB) - `sub_type` (required) - The type of document (e.g., `BankStatement`, `UtilityBill`). See \"Supported document types\" below. - `minimum_document_length` (optional) - Minimum document age in months. Documents older than this will fail the `document_age_valid` check. **Supported document types (`sub_type`):** - `Payslip` - Employment payslips - `PensionAnnualStatement` - Pension statements - `BenefitsLetter` - Government benefits letters - `HMPPSLetter` - Probation service letters - `NHSLetter` - NHS correspondence - `BankStatement` - Bank account statements - `CreditCardStatement` - Credit card statements - `MortgageStatement` - Mortgage statements - `UtilityBill` - Gas, electricity, water bills - `MobilePhoneBill` - Mobile phone bills **Validations performed:** - `required_fields_extracted` - Key identity fields were successfully extracted. These are: `first_name`, `last_name`, `first_line_of_address` and `postcode` - `category_match` - Document matches the specified sub_type - `document_age_valid` - Document is within acceptable age range (only if `minimum_document_length` provided) - `document_complete_and_legible` - Document is complete and readable - `tampering_signals_check` - No signs of document tampering detected Sandbox testing: In sandbox mode, the endpoint returns a mock \"pass\" response with sandbox values. No actual document processing occurs. > **Request behaviour:** This is a synchronous endpoint. Processing typically takes 5-15 seconds > depending on document complexity. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
92
+ */
93
+ async verifySupportingDocumentRaw(requestParameters, initOverrides) {
94
+ if (requestParameters['document'] == null) {
95
+ throw new runtime.RequiredError('document', 'Required parameter "document" was null or undefined when calling verifySupportingDocument().');
96
+ }
97
+ if (requestParameters['subType'] == null) {
98
+ throw new runtime.RequiredError('subType', 'Required parameter "subType" was null or undefined when calling verifySupportingDocument().');
99
+ }
100
+ const queryParameters = {};
101
+ const headerParameters = {};
102
+ if (this.configuration && this.configuration.accessToken) {
103
+ const token = this.configuration.accessToken;
104
+ const tokenString = await token("bearerAuth", []);
105
+ if (tokenString) {
106
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
107
+ }
108
+ }
109
+ const consumes = [
110
+ { contentType: 'multipart/form-data' },
111
+ ];
112
+ // @ts-ignore: canConsumeForm may be unused
113
+ const canConsumeForm = runtime.canConsumeForm(consumes);
114
+ let formParams;
115
+ let useForm = false;
116
+ // use FormData to transmit files using content-type "multipart/form-data"
117
+ useForm = canConsumeForm;
118
+ if (useForm) {
119
+ formParams = new FormData();
120
+ }
121
+ else {
122
+ formParams = new URLSearchParams();
123
+ }
124
+ if (requestParameters['document'] != null) {
125
+ formParams.append('document', requestParameters['document']);
126
+ }
127
+ if (requestParameters['subType'] != null) {
128
+ formParams.append('sub_type', requestParameters['subType']);
129
+ }
130
+ if (requestParameters['minimumDocumentLength'] != null) {
131
+ formParams.append('minimum_document_length', requestParameters['minimumDocumentLength']);
132
+ }
133
+ let urlPath = `/verify/supporting-documents`;
134
+ const response = await this.request({
135
+ path: urlPath,
136
+ method: 'POST',
137
+ headers: headerParameters,
138
+ query: queryParameters,
139
+ body: formParams,
140
+ }, initOverrides);
141
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SupportingDocumentVerificationResponseFromJSON)(jsonValue));
142
+ }
143
+ /**
144
+ * <div style=\"background-color: #ffebee; border-left: 4px solid #c62828; padding: 12px 16px; margin: 10px 0;\"> <strong style=\"color: #c62828;\">Experimental (beta):</strong> This feature is new and currently in beta. </div> Extract and validate a supporting document. This endpoint accepts a document file (PDF, JPG, or PNG) and extracts personal identity information and address details. **Request format:** This endpoint accepts `multipart/form-data` with: - `document` - The document file (PDF, JPG, or PNG, max 10MB) - `sub_type` (required) - The type of document (e.g., `BankStatement`, `UtilityBill`). See \"Supported document types\" below. - `minimum_document_length` (optional) - Minimum document age in months. Documents older than this will fail the `document_age_valid` check. **Supported document types (`sub_type`):** - `Payslip` - Employment payslips - `PensionAnnualStatement` - Pension statements - `BenefitsLetter` - Government benefits letters - `HMPPSLetter` - Probation service letters - `NHSLetter` - NHS correspondence - `BankStatement` - Bank account statements - `CreditCardStatement` - Credit card statements - `MortgageStatement` - Mortgage statements - `UtilityBill` - Gas, electricity, water bills - `MobilePhoneBill` - Mobile phone bills **Validations performed:** - `required_fields_extracted` - Key identity fields were successfully extracted. These are: `first_name`, `last_name`, `first_line_of_address` and `postcode` - `category_match` - Document matches the specified sub_type - `document_age_valid` - Document is within acceptable age range (only if `minimum_document_length` provided) - `document_complete_and_legible` - Document is complete and readable - `tampering_signals_check` - No signs of document tampering detected Sandbox testing: In sandbox mode, the endpoint returns a mock \"pass\" response with sandbox values. No actual document processing occurs. > **Request behaviour:** This is a synchronous endpoint. Processing typically takes 5-15 seconds > depending on document complexity. > This endpoint supports sandbox mode. [See how sandbox mode works](https://help.vouchsafe.id/en/articles/11979598-how-does-sandbox-mode-work).
145
+ */
146
+ async verifySupportingDocument(requestParameters, initOverrides) {
147
+ const response = await this.verifySupportingDocumentRaw(requestParameters, initOverrides);
148
+ return await response.value();
149
+ }
150
+ }
151
+ exports.VerifyApi = VerifyApi;
152
+ //# sourceMappingURL=VerifyApi.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"VerifyApi.js","sourceRoot":"","sources":["../../../src/openapi/apis/VerifyApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,oDAAsC;AAOtC,2CASyB;AAYzB;;GAEG;AACH,MAAa,SAAU,SAAQ,OAAO,CAAC,OAAO;IAE1C;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,iBAAqC,EAAE,aAA0D;QAClH,IAAI,iBAAiB,CAAC,wBAAwB,CAAC,IAAI,IAAI,EAAE,CAAC;YACtD,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,wBAAwB,EACxB,+FAA+F,CAClG,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,gBAAgB,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAEtD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QAED,IAAI,OAAO,GAAG,eAAe,CAAC;QAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,IAAA,oCAA4B,EAAC,iBAAiB,CAAC,wBAAwB,CAAC,CAAC;SAClF,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,yCAAiC,EAAC,SAAS,CAAC,CAAC,CAAC;IAC9G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,iBAAqC,EAAE,aAA0D;QAC/G,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC7E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,2BAA2B,CAAC,iBAAkD,EAAE,aAA0D;QAC5I,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,UAAU,EACV,8FAA8F,CACjG,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,SAAS,EACT,6FAA6F,CAChG,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QACD,MAAM,QAAQ,GAAsB;YAChC,EAAE,WAAW,EAAE,qBAAqB,EAAE;SACzC,CAAC;QACF,2CAA2C;QAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAsD,CAAC;QAC3D,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,0EAA0E;QAC1E,OAAO,GAAG,cAAc,CAAC;QACzB,IAAI,OAAO,EAAE,CAAC;YACV,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,CAAC;aAAM,CAAC;YACJ,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,UAAU,CAAQ,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,iBAAiB,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YACvC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,SAAS,CAAQ,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,iBAAiB,CAAC,uBAAuB,CAAC,IAAI,IAAI,EAAE,CAAC;YACrD,UAAU,CAAC,MAAM,CAAC,yBAAyB,EAAE,iBAAiB,CAAC,uBAAuB,CAAQ,CAAC,CAAC;QACpG,CAAC;QAGD,IAAI,OAAO,GAAG,8BAA8B,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,UAAU;SACnB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAA,sDAA8C,EAAC,SAAS,CAAC,CAAC,CAAC;IAC3H,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAAC,iBAAkD,EAAE,aAA0D;QACzI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC1F,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAjID,8BAiIC"}
@@ -1,10 +1,9 @@
1
1
  export * from './ArtefactsApi';
2
2
  export * from './AuthenticationApi';
3
3
  export * from './DigitalIDApi';
4
- export * from './EVisaVerificationApi';
5
4
  export * from './FlowsApi';
6
5
  export * from './SmartLookupsApi';
7
- export * from './SupportingDocumentVerificationApi';
8
6
  export * from './TeamApi';
9
7
  export * from './VerificationsApi';
8
+ export * from './VerifyApi';
10
9
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/openapi/apis/index.ts"],"names":[],"mappings":"AAEA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,qCAAqC,CAAC;AACpD,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/openapi/apis/index.ts"],"names":[],"mappings":"AAEA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC"}
@@ -19,10 +19,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
19
19
  __exportStar(require("./ArtefactsApi"), exports);
20
20
  __exportStar(require("./AuthenticationApi"), exports);
21
21
  __exportStar(require("./DigitalIDApi"), exports);
22
- __exportStar(require("./EVisaVerificationApi"), exports);
23
22
  __exportStar(require("./FlowsApi"), exports);
24
23
  __exportStar(require("./SmartLookupsApi"), exports);
25
- __exportStar(require("./SupportingDocumentVerificationApi"), exports);
26
24
  __exportStar(require("./TeamApi"), exports);
27
25
  __exportStar(require("./VerificationsApi"), exports);
26
+ __exportStar(require("./VerifyApi"), exports);
28
27
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/openapi/apis/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oBAAoB;AACpB,oBAAoB;AACpB,iDAA+B;AAC/B,sDAAoC;AACpC,iDAA+B;AAC/B,yDAAuC;AACvC,6CAA2B;AAC3B,oDAAkC;AAClC,sEAAoD;AACpD,4CAA0B;AAC1B,qDAAmC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/openapi/apis/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oBAAoB;AACpB,oBAAoB;AACpB,iDAA+B;AAC/B,sDAAoC;AACpC,iDAA+B;AAC/B,6CAA2B;AAC3B,oDAAkC;AAClC,4CAA0B;AAC1B,qDAAmC;AACnC,8CAA4B"}
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Vouchsafe API docs
3
+ * Vouchsafe offers a REST API to conduct operations programmatically. You can request and manage verifications, as well as perform smart lookups. To use the API, you need a client ID and secret from the Vouchsafe dashboard. [Sign up here](https://app.vouchsafe.id/) if you haven\'t already. We also have a [video guide](https://www.youtube.com/playlist?list=PLx6V6SSTMuF_ZNWBPnysvwmdIwboLViE8) showing the basics, as well as [SDKs and libraries](https://help.vouchsafe.id/en/articles/12026847-vouchsafe-sdks-and-libraries) for popular languages.
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ * Contact: help@vouchsafe.id
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ */
16
+ export declare const EvisaExistsFailedReason: {
17
+ readonly ShareCodeError: "SHARE_CODE_ERROR";
18
+ readonly IncorrectDetails: "INCORRECT_DETAILS";
19
+ };
20
+ export type EvisaExistsFailedReason = typeof EvisaExistsFailedReason[keyof typeof EvisaExistsFailedReason];
21
+ export declare function instanceOfEvisaExistsFailedReason(value: any): boolean;
22
+ export declare function EvisaExistsFailedReasonFromJSON(json: any): EvisaExistsFailedReason;
23
+ export declare function EvisaExistsFailedReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): EvisaExistsFailedReason;
24
+ export declare function EvisaExistsFailedReasonToJSON(value?: EvisaExistsFailedReason | null): any;
25
+ export declare function EvisaExistsFailedReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): EvisaExistsFailedReason;
26
+ //# sourceMappingURL=EvisaExistsFailedReason.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"EvisaExistsFailedReason.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/EvisaExistsFailedReason.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;CAG1B,CAAC;AACX,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAC;AAG3G,wBAAgB,iCAAiC,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CASrE;AAED,wBAAgB,+BAA+B,CAAC,IAAI,EAAE,GAAG,GAAG,uBAAuB,CAElF;AAED,wBAAgB,oCAAoC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,uBAAuB,CAErH;AAED,wBAAgB,6BAA6B,CAAC,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,GAAG,GAAG,CAEzF;AAED,wBAAgB,kCAAkC,CAAC,KAAK,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,uBAAuB,CAEpH"}