@trinsic/api 3.0.1 → 3.1.0-preview1

package/docs/OrderDirection.md

@@ -0,0 +1,32 @@
+
+# OrderDirection
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { OrderDirection } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies OrderDirection
+
+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 OrderDirection
+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/OutputFrejaAddress.md

@@ -0,0 +1,40 @@
+
+# OutputFrejaAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`line1` | string
+`city` | string
+`postalCode` | string
+`country` | string
+
+## Example
+
+```typescript
+import type { OutputFrejaAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "line1": 123 Residential St,
+  "city": New York,
+  "postalCode": 12345,
+  "country": SE,
+} satisfies OutputFrejaAddress
+
+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 OutputFrejaAddress
+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/OutputFrejaDocument.md

@@ -0,0 +1,40 @@
+
+# OutputFrejaDocument
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`serialNumber` | string
+`expirationDate` | Date
+`country` | string
+
+## Example
+
+```typescript
+import type { OutputFrejaDocument } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": PASS,
+  "serialNumber": SA1234567890,
+  "expirationDate": Sun Dec 31 00:00:00 UTC 2028,
+  "country": SE,
+} satisfies OutputFrejaDocument
+
+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 OutputFrejaDocument
+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/PanamaCedulaLookupInput.md

@@ -0,0 +1,36 @@
+
+# PanamaCedulaLookupInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentNumber` | string
+`dateOfBirth` | Date
+
+## Example
+
+```typescript
+import type { PanamaCedulaLookupInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentNumber": 8-1234-12345,
+  "dateOfBirth": Mon Mar 02 00:00:00 UTC 1992,
+} satisfies PanamaCedulaLookupInput
+
+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 PanamaCedulaLookupInput
+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/PanamaCedulaProviderOutput.md

@@ -0,0 +1,49 @@
+
+# PanamaCedulaProviderOutput
+
+Exposed properties for the `panama-cedula-lookup` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`documentNumber` | string
+`nationalityOrResidenceType` | string
+`subdivisionOfOrigin` | string
+`subdivisionOfOriginName` | string
+
+## Example
+
+```typescript
+import type { PanamaCedulaProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": Juan Pérez,
+  "givenName": Juan,
+  "familyName": Pérez,
+  "dateOfBirth": Mon Mar 02 00:00:00 UTC 1992,
+  "documentNumber": 8-1234-12345,
+  "nationalityOrResidenceType": BornInPanama,
+  "subdivisionOfOrigin": PA-8,
+  "subdivisionOfOriginName": Panamá,
+} satisfies PanamaCedulaProviderOutput
+
+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 PanamaCedulaProviderOutput
+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/PersonData.md

@@ -0,0 +1,53 @@
+
+# PersonData
+
+Identity information for the individual being verified
+
+## Properties
+
+Name | Type
+------------ | -------------
+`givenName` | string
+`familyName` | string
+`middleName` | string
+`fullName` | string
+`suffix` | string
+`nationality` | string
+`sex` | [Sex](Sex.md)
+`phoneNumber` | string
+`address` | [Address](Address.md)
+`dateOfBirth` | Date
+
+## Example
+
+```typescript
+import type { PersonData } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "givenName": John,
+  "familyName": Doe,
+  "middleName": Jacob,
+  "fullName": John Jacob de Doe,
+  "suffix": null,
+  "nationality": null,
+  "sex": null,
+  "phoneNumber": null,
+  "address": null,
+  "dateOfBirth": null,
+} satisfies PersonData
+
+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 PersonData
+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/PeruDniAddress.md

@@ -0,0 +1,39 @@
+
+# PeruDniAddress
+
+Not a typical address. Does not include street or city. Instead, includes region, province and district.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`region` | string
+`province` | string
+`district` | string
+
+## Example
+
+```typescript
+import type { PeruDniAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "region": CUSCO,
+  "province": URUBAMBA,
+  "district": MACHUPICCHU,
+} satisfies PeruDniAddress
+
+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 PeruDniAddress
+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/PeruDniLookupInput.md

@@ -0,0 +1,34 @@
+
+# PeruDniLookupInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentNumber` | string
+
+## Example
+
+```typescript
+import type { PeruDniLookupInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentNumber": 19050215,
+} satisfies PeruDniLookupInput
+
+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 PeruDniLookupInput
+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/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)
+
+