@trinsic/api 3.0.1 → 3.1.0-preview1

package/docs/Sex.md

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

@@ -0,0 +1,57 @@
+
+# SignzyIndiaAadhaarFetchProviderOutput
+
+Exposed properties for the `india-digilocker-aadhaar-fetch` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentType` | string
+`timestamp` | Date
+`timeToLive` | Date
+`aadhaarNumberLastFour` | string
+`claims` | [AadhaarClaims](AadhaarClaims.md)
+`localizedClaims` | [AadhaarLocalizedClaims](AadhaarLocalizedClaims.md)
+`documentSignatureValidated` | boolean
+`digilockerId` | string
+`issuerId` | string
+`issuer` | string
+`mobilePhone` | string
+`scope` | Array<string>
+
+## Example
+
+```typescript
+import type { SignzyIndiaAadhaarFetchProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentType": ADHAR,
+  "timestamp": 2025-06-01T20:43:54.472+05:30,
+  "timeToLive": null,
+  "aadhaarNumberLastFour": 1234,
+  "claims": null,
+  "localizedClaims": null,
+  "documentSignatureValidated": true,
+  "digilockerId": 9b2d5f6e-3c4a-4d7f-a1e2-8f6b9c0d1a2e,
+  "issuerId": in.gov.uidai,
+  "issuer": Unique Identification Authority of India (UIDAI),
+  "mobilePhone": 7981112222,
+  "scope": ["file.partners/PANCR","userdetails","email","files.issueddocs","picture"],
+} satisfies SignzyIndiaAadhaarFetchProviderOutput
+
+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 SignzyIndiaAadhaarFetchProviderOutput
+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/SingpassLoginProviderOutput.md

@@ -0,0 +1,47 @@
+
+# SingpassLoginProviderOutput
+
+Exposed properties for the `singpass-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sub` | string
+`accountType` | string
+`identityNumber` | string
+`countryOfIssuance` | string
+`name` | string
+`email` | string
+`mobileNumber` | string
+
+## Example
+
+```typescript
+import type { SingpassLoginProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sub": e3f1c2d4-8a9b-4c2d-b3f1-9a8b7c6d5e4f,
+  "accountType": standard,
+  "identityNumber": S1234567A,
+  "countryOfIssuance": SG,
+  "name": Lim Wei Ming,
+  "email": wei.ming.lim@example.sg,
+  "mobileNumber": +6591234567,
+} satisfies SingpassLoginProviderOutput
+
+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 SingpassLoginProviderOutput
+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/SingpassMyInfoDescription.md

@@ -0,0 +1,36 @@
+
+# SingpassMyInfoDescription
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { SingpassMyInfoDescription } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": P1Pass,
+  "description": Employment Pass,
+} satisfies SingpassMyInfoDescription
+
+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 SingpassMyInfoDescription
+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/SingpassMyInfoProviderOutput.md

@@ -0,0 +1,37 @@
+
+# SingpassMyInfoProviderOutput
+
+Exposed properties for the `singpass-myinfo` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sub` | string
+`personInfo` | [SingpassPersonalCatalog](SingpassPersonalCatalog.md)
+
+## Example
+
+```typescript
+import type { SingpassMyInfoProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sub": e3f1c2d4-8a9b-4c2d-b3f1-9a8b7c6d5e4f,
+  "personInfo": null,
+} satisfies SingpassMyInfoProviderOutput
+
+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 SingpassMyInfoProviderOutput
+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/SingpassMyInfoRegisteredAddressOutput.md

@@ -0,0 +1,53 @@
+
+# SingpassMyInfoRegisteredAddressOutput
+
+The structured MyInfo registered address payload.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`block` | string
+`building` | string
+`floor` | string
+`unit` | string
+`street` | string
+`postal` | string
+`country` | string
+`line1` | string
+`line2` | string
+
+## Example
+
+```typescript
+import type { SingpassMyInfoRegisteredAddressOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": SG,
+  "block": 548,
+  "building": Bedok Mall,
+  "floor": 09,
+  "unit": 128,
+  "street": BEDOK NORTH AVENUE 1,
+  "postal": 460548,
+  "country": SG,
+  "line1": 123 Market St.,
+  "line2": San Francisco, CA 81111 US,
+} satisfies SingpassMyInfoRegisteredAddressOutput
+
+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 SingpassMyInfoRegisteredAddressOutput
+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/SingpassPersonalCatalog.md

@@ -0,0 +1,81 @@
+
+# SingpassPersonalCatalog
+
+MyInfo Personal catalog.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`identityNumber` | string
+`partialIdentityNumber` | string
+`name` | string
+`aliasName` | string
+`hanyuPinyinName` | string
+`hanyuPinyinAliasName` | string
+`marriedName` | string
+`email` | string
+`mobileNumber` | [SingpassPhoneNumber](SingpassPhoneNumber.md)
+`dialect` | [SingpassMyInfoDescription](SingpassMyInfoDescription.md)
+`dateOfBirth` | Date
+`residentialStatus` | [SingpassMyInfoDescription](SingpassMyInfoDescription.md)
+`nationality` | string
+`birthCountry` | string
+`passportNumber` | string
+`passportExpiryDate` | Date
+`passType` | [SingpassMyInfoDescription](SingpassMyInfoDescription.md)
+`passStatus` | string
+`passExpiryDate` | Date
+`employmentSector` | string
+`registeredAddress` | [SingpassMyInfoRegisteredAddressOutput](SingpassMyInfoRegisteredAddressOutput.md)
+`houseDevelopmenetBoardType` | [SingpassMyInfoDescription](SingpassMyInfoDescription.md)
+`housingType` | [SingpassMyInfoDescription](SingpassMyInfoDescription.md)
+`sex` | string
+
+## Example
+
+```typescript
+import type { SingpassPersonalCatalog } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "identityNumber": S1234567A,
+  "partialIdentityNumber": *****567A,
+  "name": CHEN PEI NI (CHEN PEI NI) @ LEE PEI HUI (LI PEI HUI) MRS TAN,
+  "aliasName": LEE PEI HUI,
+  "hanyuPinyinName": LI PEI HUI,
+  "hanyuPinyinAliasName": LI PEI HUI,
+  "marriedName": MRS TAN,
+  "email": myinfotesting@gmail.com,
+  "mobileNumber": null,
+  "dialect": null,
+  "dateOfBirth": Sat Mar 03 00:00:00 UTC 1990,
+  "residentialStatus": null,
+  "nationality": SG,
+  "birthCountry": SG,
+  "passportNumber": E35463874W,
+  "passportExpiryDate": Tue Jan 01 00:00:00 UTC 2030,
+  "passType": null,
+  "passStatus": Live,
+  "passExpiryDate": Tue Dec 31 00:00:00 UTC 2030,
+  "employmentSector": Technology,
+  "registeredAddress": null,
+  "houseDevelopmenetBoardType": null,
+  "housingType": null,
+  "sex": Female ,
+} satisfies SingpassPersonalCatalog
+
+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 SingpassPersonalCatalog
+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/SingpassPhoneNumber.md

@@ -0,0 +1,39 @@
+
+# SingpassPhoneNumber
+
+The structured MyInfo mobile number payload.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`prefix` | string
+`areaCode` | string
+`number` | string
+
+## Example
+
+```typescript
+import type { SingpassPhoneNumber } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "prefix": +,
+  "areaCode": 65,
+  "number": 97399245,
+} satisfies SingpassPhoneNumber
+
+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 SingpassPhoneNumber
+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/SmartIdInput.md

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

@@ -0,0 +1,59 @@
+
+# SmartIdProviderOutput
+
+Exposed properties for the `smart-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
+`certificateLevel` | string
+`documentNumber` | string
+`interactionFlowUsed` | string
+`deviceIpAddress` | string
+
+## Example
+
+```typescript
+import type { SmartIdProviderOutput } 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,
+  "certificateLevel": QUALIFIED,
+  "documentNumber": PNOEE-48501010014-Z1B2-Q,
+  "interactionFlowUsed": displayTextAndPIN,
+  "deviceIpAddress": 192.168.1.100,
+} satisfies SmartIdProviderOutput
+
+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 SmartIdProviderOutput
+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/SouthAfricaNidBiometric2Input.md

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

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

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

@@ -0,0 +1,46 @@
+
+# SouthAfricaNidMatch2Input
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`idNumber` | string
+`givenName` | string
+`familyName` | string
+`middleName` | string
+`dateOfBirth` | Date
+`sex` | [SouthAfricaNidMatch2InputSex](SouthAfricaNidMatch2InputSex.md)
+`phoneNumber` | string
+
+## Example
+
+```typescript
+import type { SouthAfricaNidMatch2Input } 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 SouthAfricaNidMatch2Input
+
+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 SouthAfricaNidMatch2Input
+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/SouthAfricaNidMatch2InputSex.md

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