@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/docs/PeruDniProviderOutput.md

@@ -0,0 +1,65 @@
+
+# PeruDniProviderOutput
+
+Exposed properties for the `peru-dni-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`address` | [PeruDniAddress](PeruDniAddress.md)
+`arrayName` | Array<string>
+`civilStatus` | string
+`dateOfBirth` | Date
+`documentNumber` | string
+`documentType` | string
+`expeditionDate` | Date
+`expirationDate` | Date
+`firstName` | string
+`fullName` | string
+`lastName` | string
+`maternalLastName` | string
+`paternalLastName` | string
+`sex` | string
+`ubigeoReniec` | string
+`verificationDigit` | string
+
+## Example
+
+```typescript
+import type { PeruDniProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "address": null,
+  "arrayName": ["QUISPE","MAMANI","JUAN","CARLOS"],
+  "civilStatus": Single,
+  "dateOfBirth": Thu Jan 14 00:00:00 UTC 1999,
+  "documentNumber": 19050215,
+  "documentType": DNI,
+  "expeditionDate": Tue Jan 14 00:00:00 UTC 2025,
+  "expirationDate": Fri Jan 14 00:00:00 UTC 2033,
+  "firstName": JUAN CARLOS,
+  "fullName": JUAN CARLOS QUISPE MAMANI,
+  "lastName": QUISPE MAMANI,
+  "maternalLastName": MAMANI,
+  "paternalLastName": QUISPE,
+  "sex": Male,
+  "ubigeoReniec": 081304,
+  "verificationDigit": 7,
+} satisfies PeruDniProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PeruDniProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PhilippineMatchInput.md

@@ -0,0 +1,42 @@
+
+# PhilippineMatchInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`givenName` | string
+`middleName` | string
+`familyName` | string
+`suffix` | string
+`dateOfBirth` | Date
+
+## Example
+
+```typescript
+import type { PhilippineMatchInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "givenName": null,
+  "middleName": null,
+  "familyName": null,
+  "suffix": null,
+  "dateOfBirth": null,
+} satisfies PhilippineMatchInput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PhilippineMatchInput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PhilippineQRInput.md

@@ -0,0 +1,36 @@
+
+# PhilippineQRInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`qrCodeText` | string
+`qrCodeImage` | string
+
+## Example
+
+```typescript
+import type { PhilippineQRInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "qrCodeText": null,
+  "qrCodeImage": null,
+} satisfies PhilippineQRInput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PhilippineQRInput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PhilippinesDigitalNidProviderOutput.md

@@ -0,0 +1,55 @@
+
+# PhilippinesDigitalNidProviderOutput
+
+Exposed properties for the `philippines-digital-national-id-qr` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`philsysCardNumber` | string
+`givenName` | string
+`middleName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`suffix` | string
+`sex` | string
+`placeOfBirth` | string
+`documentIssueDate` | Date
+`documentNumber` | string
+`issuingAuthority` | string
+
+## Example
+
+```typescript
+import type { PhilippinesDigitalNidProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "philsysCardNumber": 1234-5678-9101-1213,
+  "givenName": Juan,
+  "middleName": Santos,
+  "familyName": Dela Cruz,
+  "dateOfBirth": Thu Jan 31 00:00:00 UTC 1985,
+  "suffix": Jr.,
+  "sex": Male,
+  "placeOfBirth": Manila,
+  "documentIssueDate": Fri Mar 15 00:00:00 UTC 2024,
+  "documentNumber": 12345678901234,
+  "issuingAuthority": Philippine Statistics Authority,
+} satisfies PhilippinesDigitalNidProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PhilippinesDigitalNidProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PhilippinesPhysicalNidProviderOutput.md

@@ -0,0 +1,51 @@
+
+# PhilippinesPhysicalNidProviderOutput
+
+Exposed properties for the `philippines-physical-national-id-qr` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`philsysCardNumber` | string
+`givenName` | string
+`middleName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`suffix` | string
+`sex` | string
+`placeOfBirth` | string
+`documentIssueDate` | Date
+
+## Example
+
+```typescript
+import type { PhilippinesPhysicalNidProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "philsysCardNumber": 1234-5678-9101-1213,
+  "givenName": Juan,
+  "middleName": Santos,
+  "familyName": Dela Cruz,
+  "dateOfBirth": Thu Jan 31 00:00:00 UTC 1985,
+  "suffix": Jr.,
+  "sex": Male,
+  "placeOfBirth": Manila,
+  "documentIssueDate": Fri Mar 15 00:00:00 UTC 2024,
+} satisfies PhilippinesPhysicalNidProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PhilippinesPhysicalNidProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PolandEdoAppProviderOutput.md

@@ -0,0 +1,41 @@
+
+# PolandEdoAppProviderOutput
+
+Exposed properties for the `a-edoapp-eid-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`nationalIdentificationNumber` | string
+
+## Example
+
+```typescript
+import type { PolandEdoAppProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": John,
+  "lastName": Doe,
+  "dateOfBirth": Tue Dec 10 00:00:00 UTC 1985,
+  "nationalIdentificationNumber": 90063014513,
+} satisfies PolandEdoAppProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PolandEdoAppProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PolandMobywatelMatchInput.md

@@ -0,0 +1,48 @@
+
+# PolandMobywatelMatchInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | string
+`nationality` | string
+`personalNumber` | string
+`expirationDate` | string
+`selfieBytes` | string
+`selfieImageMimeType` | string
+
+## Example
+
+```typescript
+import type { PolandMobywatelMatchInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "givenName": Jan,
+  "familyName": Kowalski,
+  "dateOfBirth": 1980-10-20,
+  "nationality": PL,
+  "personalNumber": 80102005992,
+  "expirationDate": 2030-12-31,
+  "selfieBytes": null,
+  "selfieImageMimeType": null,
+} satisfies PolandMobywatelMatchInput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PolandMobywatelMatchInput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PolandMobywatelMatchProviderOutput.md

@@ -0,0 +1,73 @@
+
+# PolandMobywatelMatchProviderOutput
+
+Exposed properties for the `poland-mobywatel-match` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`givenName` | string
+`familyName` | string
+`nationality` | string
+`dateOfBirth` | Date
+`personalNumber` | string
+`expirationDate` | Date
+`isMatchForGivenNames` | boolean
+`isMatchForFamilyName` | boolean
+`isMatchForExpirationDate` | boolean
+`isMatchForPersonalNumber` | boolean
+`isMatchForNationality` | boolean
+`isMatchForBirthDate` | boolean
+`isMatchForSelfie` | boolean
+`isNotTooSimilarToDocumentPortrait` | boolean
+`isNotDifferentFace` | boolean
+`isSingleFace` | boolean
+`isOverAge` | boolean
+`isAgeEstimationMatchForSelfie` | boolean
+`ageEstimationThreshold` | number
+`estimatedAgeFromSelfie` | number
+
+## Example
+
+```typescript
+import type { PolandMobywatelMatchProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "givenName": Jan,
+  "familyName": Kowalski,
+  "nationality": PL,
+  "dateOfBirth": Mon Oct 20 00:00:00 UTC 1980,
+  "personalNumber": 80102005992,
+  "expirationDate": Tue Dec 31 00:00:00 UTC 2030,
+  "isMatchForGivenNames": true,
+  "isMatchForFamilyName": true,
+  "isMatchForExpirationDate": true,
+  "isMatchForPersonalNumber": true,
+  "isMatchForNationality": true,
+  "isMatchForBirthDate": true,
+  "isMatchForSelfie": true,
+  "isNotTooSimilarToDocumentPortrait": true,
+  "isNotDifferentFace": true,
+  "isSingleFace": true,
+  "isOverAge": true,
+  "isAgeEstimationMatchForSelfie": true,
+  "ageEstimationThreshold": 4,
+  "estimatedAgeFromSelfie": 35,
+} satisfies PolandMobywatelMatchProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PolandMobywatelMatchProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PolandMojeIdProviderOutput.md

@@ -0,0 +1,39 @@
+
+# PolandMojeIdProviderOutput
+
+Exposed properties for the `a-pl-mojeid-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`nationalIdentificationNumber` | string
+
+## Example
+
+```typescript
+import type { PolandMojeIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": John,
+  "lastName": Doe,
+  "nationalIdentificationNumber": 90063014513,
+} satisfies PolandMojeIdProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PolandMojeIdProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PortugalIdCardProviderOutput.md

@@ -0,0 +1,41 @@
+
+# PortugalIdCardProviderOutput
+
+Exposed properties for the `a-pt-id-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`dateOfBirth` | Date
+`civilIdentificationNumber` | string
+
+## Example
+
+```typescript
+import type { PortugalIdCardProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": John,
+  "lastName": Doe,
+  "dateOfBirth": Tue Dec 10 00:00:00 UTC 1985,
+  "civilIdentificationNumber": 12345678,
+} satisfies PortugalIdCardProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PortugalIdCardProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PostOfficeEasyIdProviderOutput.md

@@ -0,0 +1,57 @@
+
+# PostOfficeEasyIdProviderOutput
+
+Exposed properties for the `post-office-easyid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`rememberMeId` | string
+`email` | string
+`givenName` | string
+`familyName` | string
+`fullName` | string
+`dateOfBirth` | Date
+`gender` | string
+`nationality` | string
+`mobileNumber` | string
+`structuredPostalAddress` | [YotiStructuredPostalAddress](YotiStructuredPostalAddress.md)
+`postalAddress` | string
+`documentDetails` | [YotiDocumentDetails](YotiDocumentDetails.md)
+
+## Example
+
+```typescript
+import type { PostOfficeEasyIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "rememberMeId": 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
+  "email": johndoe@example.com,
+  "givenName": John Alvin,
+  "familyName": Doe,
+  "fullName": John Alvin Doe,
+  "dateOfBirth": Thu Jan 31 00:00:00 UTC 1985,
+  "gender": MALE,
+  "nationality": GBR,
+  "mobileNumber": +447777123456,
+  "structuredPostalAddress": null,
+  "postalAddress": 6th Floor, 107 Leadenhall St, London, EC3A 4AF,
+  "documentDetails": null,
+} satisfies PostOfficeEasyIdProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostOfficeEasyIdProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ProblemDetails.md

@@ -0,0 +1,42 @@
+
+# ProblemDetails
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`title` | string
+`status` | number
+`detail` | string
+`instance` | string
+
+## Example
+
+```typescript
+import type { ProblemDetails } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "title": null,
+  "status": null,
+  "detail": null,
+  "instance": null,
+} satisfies ProblemDetails
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ProblemDetails
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Provider.md

@@ -0,0 +1,78 @@
+
+# Provider
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`logoUrl` | string
+`subtext` | string
+`description` | string
+`geography` | Array<string>
+`regions` | Array<string>
+`countries` | Array<string>
+`subdivisions` | Array<string>
+`licensed` | boolean
+`launchMethod` | [IntegrationLaunchMethod](IntegrationLaunchMethod.md)
+`collectionMethod` | [ResultCollectionMethod](ResultCollectionMethod.md)
+`resultsMayBeDelayedAfterRedirect` | boolean
+`hasRefreshableContent` | boolean
+`requiresInput` | boolean
+`hasTrinsicInterface` | boolean
+`supportsDirectProviderSessions` | boolean
+`supportedLanguages` | [Array<ProviderSupportedLanguage>](ProviderSupportedLanguage.md)
+`availableAttributes` | [Array<ContractAttribute>](ContractAttribute.md)
+`availableAttachments` | [Array<ContractAttachment>](ContractAttachment.md)
+`subProviders` | [Array<SubProviderMetadata>](SubProviderMetadata.md)
+`liveHealth` | [ProviderHealth](ProviderHealth.md)
+`testHealth` | [ProviderHealth](ProviderHealth.md)
+
+## Example
+
+```typescript
+import type { Provider } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": yoti,
+  "name": Yoti,
+  "logoUrl": https://cdn.trinsic.id/providers/yoti.png,
+  "subtext": dmv.ca.gov,
+  "description": Identity verification via government ID and biometrics,
+  "geography": ["Global"],
+  "regions": ["Europe"],
+  "countries": ["US","CA"],
+  "subdivisions": ["US-CA","US-TX"],
+  "licensed": true,
+  "launchMethod": null,
+  "collectionMethod": null,
+  "resultsMayBeDelayedAfterRedirect": false,
+  "hasRefreshableContent": false,
+  "requiresInput": false,
+  "hasTrinsicInterface": true,
+  "supportsDirectProviderSessions": true,
+  "supportedLanguages": null,
+  "availableAttributes": null,
+  "availableAttachments": null,
+  "subProviders": null,
+  "liveHealth": null,
+  "testHealth": null,
+} satisfies Provider
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Provider
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+