@trinsic/api 3.0.1 → 3.1.0-preview1

package/docs/MobileCarrier.md

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

@@ -0,0 +1,38 @@
+
+# MobileIdInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`mobileIdPhoneNumber` | string
+`mobileIdNationalIdentityNumber` | string
+`mobileIdLanguage` | [MobileIdLanguage](MobileIdLanguage.md)
+
+## Example
+
+```typescript
+import type { MobileIdInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "mobileIdPhoneNumber": null,
+  "mobileIdNationalIdentityNumber": null,
+  "mobileIdLanguage": null,
+} satisfies MobileIdInput
+
+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 MobileIdInput
+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/MobileIdLanguage.md

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

@@ -0,0 +1,51 @@
+
+# MobileIdProviderOutput
+
+Exposed properties for the `mobile-id` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`sex` | string
+`country` | string
+`identityType` | string
+`personalCode` | string
+`serialNumber` | string
+`certificateSubject` | string
+
+## Example
+
+```typescript
+import type { MobileIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "givenName": MARI,
+  "familyName": TAMM,
+  "dateOfBirth": Tue Jan 01 00:00:00 UTC 1985,
+  "sex": Female,
+  "country": EE,
+  "identityType": PNO,
+  "personalCode": 48501010014,
+  "serialNumber": PNOEE-48501010014,
+  "certificateSubject": SERIALNUMBER=PNOEE-48501010014, G=MARI, SN=TAMM, CN="TAMM,MARI,48501010014", C=EE,
+} satisfies MobileIdProviderOutput
+
+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 MobileIdProviderOutput
+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/MobileOperatingSystem.md

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

@@ -0,0 +1,42 @@
+
+# NetherlandsIdinAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`street` | string
+`houseNumber` | string
+`postalCode` | string
+`city` | string
+`countryCode` | string
+
+## Example
+
+```typescript
+import type { NetherlandsIdinAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "street": Drieslag,
+  "houseNumber": 51,
+  "postalCode": 6832AM,
+  "city": Arnhem,
+  "countryCode": NL,
+} satisfies NetherlandsIdinAddress
+
+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 NetherlandsIdinAddress
+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/NetherlandsIdinProviderOutput.md

@@ -0,0 +1,53 @@
+
+# NetherlandsIdinProviderOutput
+
+Exposed properties for the `netherlands-idin` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`authorityId` | string
+`authorityName` | string
+`customerId` | string
+`initials` | string
+`familyName` | string
+`address` | [NetherlandsIdinAddress](NetherlandsIdinAddress.md)
+`birthDate` | Date
+`gender` | string
+`phoneNumber` | string
+`email` | string
+
+## Example
+
+```typescript
+import type { NetherlandsIdinProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "authorityId": INGBNL2A,
+  "authorityName": ING,
+  "customerId": NLINGBG344XBYRN9O+Zu7EK9ajC8Ta19fe0xDYfwudOnKRirMopP9rgG/GfV8L1Ck3UWqgYq8dNhKztgp3PRYOelbTJQ==,
+  "initials": J,
+  "familyName": De Wit,
+  "address": null,
+  "birthDate": Mon Jan 15 00:00:00 UTC 1990,
+  "gender": Male,
+  "phoneNumber": +31612345678,
+  "email": jan.dewit@example.nl,
+} satisfies NetherlandsIdinProviderOutput
+
+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 NetherlandsIdinProviderOutput
+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/NigeriaNinBiometric2Input.md

@@ -0,0 +1,38 @@
+
+# NigeriaNinBiometric2Input
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`idNumber` | string
+`livenessImages` | Array<string>
+`testSelfie` | string
+
+## Example
+
+```typescript
+import type { NigeriaNinBiometric2Input } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "idNumber": null,
+  "livenessImages": null,
+  "testSelfie": null,
+} satisfies NigeriaNinBiometric2Input
+
+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 NigeriaNinBiometric2Input
+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/NigeriaNinInput.md

@@ -0,0 +1,46 @@
+
+# NigeriaNinInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`middleName` | string
+`lastName` | string
+`phoneNumber` | string
+`dateOfBirth` | Date
+`gender` | string
+`nationalIdNumber` | string
+
+## Example
+
+```typescript
+import type { NigeriaNinInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "middleName": null,
+  "lastName": null,
+  "phoneNumber": null,
+  "dateOfBirth": null,
+  "gender": null,
+  "nationalIdNumber": null,
+} satisfies NigeriaNinInput
+
+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 NigeriaNinInput
+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/NigeriaNinLookup2Input.md

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

@@ -0,0 +1,57 @@
+
+# NigeriaNinLookup2ProviderOutput
+
+Exposed properties for the `nigeria-nin-lookup-2` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`middleName` | string
+`surname` | string
+`sex` | string
+`dateOfBirth` | Date
+`birthCountry` | string
+`nationalIdentityNumber` | string
+`phoneNumber` | string
+`email` | string
+`address` | string
+`localGovernmentArea` | string
+`state` | string
+
+## Example
+
+```typescript
+import type { NigeriaNinLookup2ProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": MUSA,
+  "middleName": IBRAHIM,
+  "surname": MOHAMMED,
+  "sex": Male,
+  "dateOfBirth": Wed Jan 31 00:00:00 UTC 1990,
+  "birthCountry": NG,
+  "nationalIdentityNumber": 12345678901,
+  "phoneNumber": +2340123456789,
+  "email": user@example.com,
+  "address": 816 ahmadu bello way central business district abuja,
+  "localGovernmentArea": Abuja Municipal,
+  "state": Federal Capital Territory,
+} satisfies NigeriaNinLookup2ProviderOutput
+
+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 NigeriaNinLookup2ProviderOutput
+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/NigeriaNinMatch2Input.md

@@ -0,0 +1,46 @@
+
+# NigeriaNinMatch2Input
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`idNumber` | string
+`givenName` | string
+`familyName` | string
+`middleName` | string
+`dateOfBirth` | Date
+`sex` | [NigeriaNinMatch2InputSex](NigeriaNinMatch2InputSex.md)
+`phoneNumber` | string
+
+## Example
+
+```typescript
+import type { NigeriaNinMatch2Input } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "idNumber": null,
+  "givenName": null,
+  "familyName": null,
+  "middleName": null,
+  "dateOfBirth": null,
+  "sex": null,
+  "phoneNumber": null,
+} satisfies NigeriaNinMatch2Input
+
+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 NigeriaNinMatch2Input
+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/NigeriaNinMatch2InputSex.md

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

@@ -0,0 +1,49 @@
+
+# NorwegianBankIdProviderOutput
+
+Exposed properties for the `norway-bankid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullName` | string
+`dateOfBirth` | Date
+`personalIdentifier` | string
+`nationalIdentityNumber` | string
+`givenName` | string
+`familyName` | string
+`levelOfAssurance` | string
+`authenticationMethod` | string
+
+## Example
+
+```typescript
+import type { NorwegianBankIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullName": Ove Henriksen,
+  "dateOfBirth": Sun Aug 15 00:00:00 UTC 1943,
+  "personalIdentifier": 9578-5999-4-1765512,
+  "nationalIdentityNumber": 30069012345,
+  "givenName": Ole,
+  "familyName": Olsen,
+  "levelOfAssurance": High,
+  "authenticationMethod": urn:bankid:bis,
+} satisfies NorwegianBankIdProviderOutput
+
+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 NorwegianBankIdProviderOutput
+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/OneIdProviderAddress.md

@@ -0,0 +1,42 @@
+
+# OneIdProviderAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`streetAddress` | string
+`locality` | string
+`region` | string
+`postalCode` | string
+`countryCode` | string
+
+## Example
+
+```typescript
+import type { OneIdProviderAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "streetAddress": 80 Temple Way, Winterton-On-Sea,
+  "locality": Great Yarmouth,
+  "region": Norfolk,
+  "postalCode": NR29 9QS,
+  "countryCode": GB,
+} satisfies OneIdProviderAddress
+
+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 OneIdProviderAddress
+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/OneIdProviderOutput.md

@@ -0,0 +1,45 @@
+
+# OneIdProviderOutput
+
+Exposed properties for the `oneid` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sub` | string
+`fullName` | string
+`givenName` | string
+`familyName` | string
+`birthdate` | Date
+`address` | [OneIdProviderAddress](OneIdProviderAddress.md)
+
+## Example
+
+```typescript
+import type { OneIdProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sub": 458924ee-f856-59ad-ae9f-6de2429a3c74,
+  "fullName": John Smith,
+  "givenName": John,
+  "familyName": Smith,
+  "birthdate": Thu Jan 31 00:00:00 UTC 1985,
+  "address": null,
+} satisfies OneIdProviderOutput
+
+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 OneIdProviderOutput
+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)
+
+