humanos 1.0.5 → 1.0.7
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.
- package/dist/index.d.mts +551 -323
- package/dist/index.d.ts +551 -323
- package/dist/index.js +33 -31
- package/dist/index.mjs +32 -31
- package/generated/.openapi-generator/FILES +13 -7
- package/generated/api/approval-api.ts +0 -2
- package/generated/api/credentials-api.ts +15 -15
- package/generated/api/requests-api.ts +8 -4
- package/generated/api/webhooks-api.ts +4 -4
- package/generated/models/create-presentation-dto.ts +1 -1
- package/generated/models/create-subject-entity.ts +3 -6
- package/generated/models/credential-entity.ts +2 -2
- package/generated/models/{w3-cverifiable-credential-proofs-inner.ts → credential-proof.ts} +20 -8
- package/generated/models/generate-request-dto.ts +15 -27
- package/generated/models/generate-request-iframe-cookie-dto.ts +36 -0
- package/generated/models/generate-request-iframe-dto.ts +39 -0
- package/generated/models/generate-request-user-dto.ts +64 -0
- package/generated/models/generate-subject-entity.ts +2 -2
- package/generated/models/identity-event-decision.ts +0 -18
- package/generated/models/identity-event.ts +3 -3
- package/generated/models/{w3-cverifiable-credential-valid-from.ts → identity-webhook-issue-date.ts} +2 -2
- package/generated/models/identity-webhook.ts +117 -0
- package/generated/models/index.ts +13 -7
- package/generated/models/{w3-cverifiable-credential-evidences-inner.ts → mandate-action.ts} +7 -5
- package/generated/models/{w3-cverifiable-credential-credential-subject-mandate-context.ts → mandate-context.ts} +3 -3
- package/generated/models/{w3-cverifiable-credential-valid-until.ts → mandate-grantor.ts} +2 -2
- package/generated/models/mandate.ts +65 -0
- package/generated/models/presentation-entity.ts +45 -0
- package/generated/models/request-detail-subject-entity.ts +6 -0
- package/generated/models/request-subject-entity.ts +6 -0
- package/generated/models/{generate400-response.ts → requests-create402-response.ts} +5 -5
- package/generated/models/{create400-response.ts → requests-create409-response.ts} +5 -5
- package/generated/models/resource-entity.ts +0 -1
- package/generated/models/resource-minimal-entity.ts +0 -1
- package/generated/models/resource-query.ts +0 -1
- package/generated/models/revoke-credential-entity.ts +0 -9
- package/generated/models/verify-presentation-dto.ts +8 -2
- package/generated/models/w3-cverifiable-credential-credential-subject.ts +3 -3
- package/generated/models/w3-cverifiable-credential.ts +5 -5
- package/generated/models/webhook-call-event.ts +1 -1
- package/package.json +1 -1
- package/generated/models/action-ref-dto.ts +0 -36
- package/generated/models/constraints-dto.ts +0 -36
- package/generated/models/create-presentation400-response.ts +0 -42
- package/generated/models/create-presentation403-response.ts +0 -42
- package/generated/models/create-presentation404-response.ts +0 -42
- package/generated/models/credential-dto-data-inner.ts +0 -26
- package/generated/models/get-credential404-response.ts +0 -42
- package/generated/models/get-evidence404-response.ts +0 -42
- package/generated/models/get-request-detail404-response.ts +0 -42
- package/generated/models/get-subject400-response.ts +0 -42
- package/generated/models/get-subject404-response.ts +0 -42
- package/generated/models/identity-payload.ts +0 -84
- package/generated/models/json-value.ts +0 -27
- package/generated/models/otp-failed-event-otp-error.ts +0 -36
- package/generated/models/presentation-receipt-entity.ts +0 -42
- package/generated/models/presentation-response-entity.ts +0 -39
- package/generated/models/resend-otp403-response.ts +0 -42
- package/generated/models/revoke-credential400-response.ts +0 -42
- package/generated/models/revoke-credential409-response.ts +0 -42
- package/generated/models/revoke-receipt-entity.ts +0 -42
- package/generated/models/schema-entity.ts +0 -57
- package/generated/models/schema-list-entity.ts +0 -39
- package/generated/models/schema-query.ts +0 -48
- package/generated/models/schema-response-entity.ts +0 -45
- package/generated/models/schema-version-detail-entity.ts +0 -72
- package/generated/models/schema-version-list-entity.ts +0 -39
- package/generated/models/schema-version-response-entity.ts +0 -54
- package/generated/models/schema-version-summary-entity.ts +0 -48
- package/generated/models/subject-contact-entity.ts +0 -42
- package/generated/models/verify-receipt-entity.ts +0 -42
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-action.ts +0 -44
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-constraint-constraint-schema.ts +0 -44
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-constraint.ts +0 -41
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate-grantor.ts +0 -24
- package/generated/models/w3-cverifiable-credential-credential-subject-mandate.ts +0 -65
- package/generated/models/webhook-event-type-credential.ts +0 -30
- package/generated/models/webhook-event-type-identity.ts +0 -30
- package/generated/models/webhook-event-type-otpfailed.ts +0 -30
- package/generated/models/webhook-event-type-test.ts +0 -30
- package/generated/models/webhook-event-type.ts +0 -33
package/dist/index.d.ts
CHANGED
|
@@ -706,7 +706,7 @@ interface ContactEntity {
|
|
|
706
706
|
*/
|
|
707
707
|
interface CreatePresentationDto {
|
|
708
708
|
/**
|
|
709
|
-
*
|
|
709
|
+
* Domain or subdomain of the intended verifier (e.g. \"organization.com\"). When provided, the VP is bound to this audience via proof.domain and a challenge nonce.
|
|
710
710
|
* @type {string}
|
|
711
711
|
* @memberof CreatePresentationDto
|
|
712
712
|
*/
|
|
@@ -940,7 +940,7 @@ interface PartialSubjectEntity {
|
|
|
940
940
|
*/
|
|
941
941
|
interface CreateSubjectEntity {
|
|
942
942
|
/**
|
|
943
|
-
* HTTP status code indicating the result of the operation for this specific subject: -
|
|
943
|
+
* HTTP status code indicating the result of the operation for this specific subject: - 201: Success — subject created or updated (the message distinguishes: \"Subject created\" vs updated) - 400: Invalid body payload. Information will be at the message field - 409: Duplicate contact within the request body - 410: Contact maps to a subject with inconsistent references (the same subject appears through more than one contact in this request) - 500: Unexpected processing error
|
|
944
944
|
* @type {number}
|
|
945
945
|
* @memberof CreateSubjectEntity
|
|
946
946
|
*/
|
|
@@ -959,14 +959,11 @@ interface CreateSubjectEntity {
|
|
|
959
959
|
'user': PartialSubjectEntity;
|
|
960
960
|
}
|
|
961
961
|
declare const CreateSubjectEntityStatusEnum: {
|
|
962
|
-
readonly NUMBER_200: 200;
|
|
963
962
|
readonly NUMBER_201: 201;
|
|
964
963
|
readonly NUMBER_400: 400;
|
|
965
|
-
readonly NUMBER_402: 402;
|
|
966
|
-
readonly NUMBER_407: 407;
|
|
967
|
-
readonly NUMBER_408: 408;
|
|
968
964
|
readonly NUMBER_409: 409;
|
|
969
965
|
readonly NUMBER_410: 410;
|
|
966
|
+
readonly NUMBER_500: 500;
|
|
970
967
|
};
|
|
971
968
|
type CreateSubjectEntityStatusEnum = typeof CreateSubjectEntityStatusEnum[keyof typeof CreateSubjectEntityStatusEnum];
|
|
972
969
|
|
|
@@ -1219,11 +1216,11 @@ interface CredentialEntity {
|
|
|
1219
1216
|
*/
|
|
1220
1217
|
'w3cCredential': object;
|
|
1221
1218
|
/**
|
|
1222
|
-
* Whether each grantor accepted or rejected the credential and information about the grantor contact. The `id` field carries the
|
|
1219
|
+
* Whether each grantor accepted or rejected the credential and information about the grantor contact. The `id` field carries the grantor\'s DID. Always an array (empty when there are no decisions yet).
|
|
1223
1220
|
* @type {Array<Array<any>>}
|
|
1224
1221
|
* @memberof CredentialEntity
|
|
1225
1222
|
*/
|
|
1226
|
-
'decisions'
|
|
1223
|
+
'decisions': Array<Array<any>>;
|
|
1227
1224
|
}
|
|
1228
1225
|
declare const CredentialEntityStatusEnum: {
|
|
1229
1226
|
readonly Draft: "DRAFT";
|
|
@@ -1399,6 +1396,74 @@ declare const CredentialEventEventTypeEnum: {
|
|
|
1399
1396
|
};
|
|
1400
1397
|
type CredentialEventEventTypeEnum = typeof CredentialEventEventTypeEnum[keyof typeof CredentialEventEventTypeEnum];
|
|
1401
1398
|
|
|
1399
|
+
/**
|
|
1400
|
+
* Humanos API
|
|
1401
|
+
* Humanos API
|
|
1402
|
+
*
|
|
1403
|
+
* The version of the OpenAPI document: 1.0
|
|
1404
|
+
*
|
|
1405
|
+
*
|
|
1406
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1407
|
+
* https://openapi-generator.tech
|
|
1408
|
+
* Do not edit the class manually.
|
|
1409
|
+
*/
|
|
1410
|
+
/**
|
|
1411
|
+
*
|
|
1412
|
+
* @export
|
|
1413
|
+
* @interface CredentialProof
|
|
1414
|
+
*/
|
|
1415
|
+
interface CredentialProof {
|
|
1416
|
+
[key: string]: any;
|
|
1417
|
+
/**
|
|
1418
|
+
*
|
|
1419
|
+
* @type {string}
|
|
1420
|
+
* @memberof CredentialProof
|
|
1421
|
+
*/
|
|
1422
|
+
'action': string;
|
|
1423
|
+
/**
|
|
1424
|
+
*
|
|
1425
|
+
* @type {string}
|
|
1426
|
+
* @memberof CredentialProof
|
|
1427
|
+
*/
|
|
1428
|
+
'actionProof': string;
|
|
1429
|
+
/**
|
|
1430
|
+
*
|
|
1431
|
+
* @type {string}
|
|
1432
|
+
* @memberof CredentialProof
|
|
1433
|
+
*/
|
|
1434
|
+
'type': string;
|
|
1435
|
+
/**
|
|
1436
|
+
*
|
|
1437
|
+
* @type {string}
|
|
1438
|
+
* @memberof CredentialProof
|
|
1439
|
+
*/
|
|
1440
|
+
'cryptosuite': string;
|
|
1441
|
+
/**
|
|
1442
|
+
*
|
|
1443
|
+
* @type {string}
|
|
1444
|
+
* @memberof CredentialProof
|
|
1445
|
+
*/
|
|
1446
|
+
'verificationMethod': string;
|
|
1447
|
+
/**
|
|
1448
|
+
*
|
|
1449
|
+
* @type {string}
|
|
1450
|
+
* @memberof CredentialProof
|
|
1451
|
+
*/
|
|
1452
|
+
'created': string;
|
|
1453
|
+
/**
|
|
1454
|
+
*
|
|
1455
|
+
* @type {string}
|
|
1456
|
+
* @memberof CredentialProof
|
|
1457
|
+
*/
|
|
1458
|
+
'proofPurpose': string;
|
|
1459
|
+
/**
|
|
1460
|
+
*
|
|
1461
|
+
* @type {string}
|
|
1462
|
+
* @memberof CredentialProof
|
|
1463
|
+
*/
|
|
1464
|
+
'proofValue': string;
|
|
1465
|
+
}
|
|
1466
|
+
|
|
1402
1467
|
/**
|
|
1403
1468
|
* Humanos API
|
|
1404
1469
|
* Humanos API
|
|
@@ -1858,6 +1923,125 @@ interface GenerateCredentialEntity {
|
|
|
1858
1923
|
'internalId'?: string;
|
|
1859
1924
|
}
|
|
1860
1925
|
|
|
1926
|
+
/**
|
|
1927
|
+
* Humanos API
|
|
1928
|
+
* Humanos API
|
|
1929
|
+
*
|
|
1930
|
+
* The version of the OpenAPI document: 1.0
|
|
1931
|
+
*
|
|
1932
|
+
*
|
|
1933
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1934
|
+
* https://openapi-generator.tech
|
|
1935
|
+
* Do not edit the class manually.
|
|
1936
|
+
*/
|
|
1937
|
+
/**
|
|
1938
|
+
*
|
|
1939
|
+
* @export
|
|
1940
|
+
* @interface GenerateRequestIFrameCookieDto
|
|
1941
|
+
*/
|
|
1942
|
+
interface GenerateRequestIFrameCookieDto {
|
|
1943
|
+
/**
|
|
1944
|
+
* Opt into a trusted browser session for this request (HUM-6): when true, a valid session cookie lets the subject skip the OTP on future approvals. Default false.
|
|
1945
|
+
* @type {boolean}
|
|
1946
|
+
* @memberof GenerateRequestIFrameCookieDto
|
|
1947
|
+
*/
|
|
1948
|
+
'allow'?: boolean;
|
|
1949
|
+
/**
|
|
1950
|
+
* Trusted-session lifespan in seconds. Used ONLY when `allow` is true (ignored otherwise — no error). Clamped to [3600 (1h), 86400 (24h)]; default 3600.
|
|
1951
|
+
* @type {number}
|
|
1952
|
+
* @memberof GenerateRequestIFrameCookieDto
|
|
1953
|
+
*/
|
|
1954
|
+
'duration'?: number;
|
|
1955
|
+
}
|
|
1956
|
+
|
|
1957
|
+
/**
|
|
1958
|
+
* Humanos API
|
|
1959
|
+
* Humanos API
|
|
1960
|
+
*
|
|
1961
|
+
* The version of the OpenAPI document: 1.0
|
|
1962
|
+
*
|
|
1963
|
+
*
|
|
1964
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1965
|
+
* https://openapi-generator.tech
|
|
1966
|
+
* Do not edit the class manually.
|
|
1967
|
+
*/
|
|
1968
|
+
|
|
1969
|
+
/**
|
|
1970
|
+
*
|
|
1971
|
+
* @export
|
|
1972
|
+
* @interface GenerateRequestIFrameDto
|
|
1973
|
+
*/
|
|
1974
|
+
interface GenerateRequestIFrameDto {
|
|
1975
|
+
/**
|
|
1976
|
+
* Base64-encoded P-256 SPKI public key to pre-register for postMessage payload encryption.
|
|
1977
|
+
* @type {string}
|
|
1978
|
+
* @memberof GenerateRequestIFrameDto
|
|
1979
|
+
*/
|
|
1980
|
+
'pubKey': string;
|
|
1981
|
+
/**
|
|
1982
|
+
* Trusted browser session config — skip the OTP for high-frequency approvals (HUM-6).
|
|
1983
|
+
* @type {GenerateRequestIFrameCookieDto}
|
|
1984
|
+
* @memberof GenerateRequestIFrameDto
|
|
1985
|
+
*/
|
|
1986
|
+
'cookie'?: GenerateRequestIFrameCookieDto;
|
|
1987
|
+
}
|
|
1988
|
+
|
|
1989
|
+
/**
|
|
1990
|
+
* Humanos API
|
|
1991
|
+
* Humanos API
|
|
1992
|
+
*
|
|
1993
|
+
* The version of the OpenAPI document: 1.0
|
|
1994
|
+
*
|
|
1995
|
+
*
|
|
1996
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1997
|
+
* https://openapi-generator.tech
|
|
1998
|
+
* Do not edit the class manually.
|
|
1999
|
+
*/
|
|
2000
|
+
/**
|
|
2001
|
+
*
|
|
2002
|
+
* @export
|
|
2003
|
+
* @interface GenerateRequestUserDto
|
|
2004
|
+
*/
|
|
2005
|
+
interface GenerateRequestUserDto {
|
|
2006
|
+
/**
|
|
2007
|
+
* Contact email or phone number
|
|
2008
|
+
* @type {string}
|
|
2009
|
+
* @memberof GenerateRequestUserDto
|
|
2010
|
+
*/
|
|
2011
|
+
'contact': string;
|
|
2012
|
+
/**
|
|
2013
|
+
* Secondary contact email or phone number. When present, first contact will receive the OTP code and the secondary contact will receive the link to complete the request.
|
|
2014
|
+
* @type {string}
|
|
2015
|
+
* @memberof GenerateRequestUserDto
|
|
2016
|
+
*/
|
|
2017
|
+
'secondaryContact'?: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* Known document ID of the user, expected to be returned by the KYC verification
|
|
2020
|
+
* @type {string}
|
|
2021
|
+
* @memberof GenerateRequestUserDto
|
|
2022
|
+
*/
|
|
2023
|
+
'docId'?: string;
|
|
2024
|
+
/**
|
|
2025
|
+
* Language for OTP notifications. Defaults to the contact phone nationality, or ENG.
|
|
2026
|
+
* @type {string}
|
|
2027
|
+
* @memberof GenerateRequestUserDto
|
|
2028
|
+
*/
|
|
2029
|
+
'language'?: GenerateRequestUserDtoLanguageEnum;
|
|
2030
|
+
/**
|
|
2031
|
+
* Signer quality for this request. Free text; if omitted for an existing member, the member quality is propagated.
|
|
2032
|
+
* @type {string}
|
|
2033
|
+
* @memberof GenerateRequestUserDto
|
|
2034
|
+
*/
|
|
2035
|
+
'signerQuality'?: string;
|
|
2036
|
+
}
|
|
2037
|
+
declare const GenerateRequestUserDtoLanguageEnum: {
|
|
2038
|
+
readonly Eng: "ENG";
|
|
2039
|
+
readonly Prt: "PRT";
|
|
2040
|
+
readonly Spa: "SPA";
|
|
2041
|
+
readonly Fra: "FRA";
|
|
2042
|
+
};
|
|
2043
|
+
type GenerateRequestUserDtoLanguageEnum = typeof GenerateRequestUserDtoLanguageEnum[keyof typeof GenerateRequestUserDtoLanguageEnum];
|
|
2044
|
+
|
|
1861
2045
|
/**
|
|
1862
2046
|
* Humanos API
|
|
1863
2047
|
* Humanos API
|
|
@@ -1883,11 +2067,17 @@ interface GenerateRequestDto {
|
|
|
1883
2067
|
*/
|
|
1884
2068
|
'name'?: string;
|
|
1885
2069
|
/**
|
|
1886
|
-
* Array of
|
|
1887
|
-
* @type {Array<
|
|
2070
|
+
* Array of users to be included in the request
|
|
2071
|
+
* @type {Array<GenerateRequestUserDto>}
|
|
1888
2072
|
* @memberof GenerateRequestDto
|
|
1889
2073
|
*/
|
|
1890
|
-
'
|
|
2074
|
+
'users': Array<GenerateRequestUserDto>;
|
|
2075
|
+
/**
|
|
2076
|
+
* IFrame configuration for the request
|
|
2077
|
+
* @type {GenerateRequestIFrameDto}
|
|
2078
|
+
* @memberof GenerateRequestDto
|
|
2079
|
+
*/
|
|
2080
|
+
'iframe'?: GenerateRequestIFrameDto;
|
|
1891
2081
|
/**
|
|
1892
2082
|
* Security level for the request
|
|
1893
2083
|
* @type {string}
|
|
@@ -1912,42 +2102,18 @@ interface GenerateRequestDto {
|
|
|
1912
2102
|
* @memberof GenerateRequestDto
|
|
1913
2103
|
*/
|
|
1914
2104
|
'credentials'?: Array<CredentialDto>;
|
|
1915
|
-
/**
|
|
1916
|
-
* What language to use when sending notifications to the user
|
|
1917
|
-
* @type {string}
|
|
1918
|
-
* @memberof GenerateRequestDto
|
|
1919
|
-
*/
|
|
1920
|
-
'language'?: string;
|
|
1921
|
-
/**
|
|
1922
|
-
* URL to redirect the subject after completing the request
|
|
1923
|
-
* @type {string}
|
|
1924
|
-
* @memberof GenerateRequestDto
|
|
1925
|
-
*/
|
|
1926
|
-
'redirectUrl'?: string;
|
|
1927
2105
|
/**
|
|
1928
2106
|
* Internal identifier for the request
|
|
1929
2107
|
* @type {string}
|
|
1930
2108
|
* @memberof GenerateRequestDto
|
|
1931
2109
|
*/
|
|
1932
2110
|
'internalId'?: string;
|
|
1933
|
-
/**
|
|
1934
|
-
* Base64-encoded P-256 SPKI public key to pre-register for postMessage payload encryption.
|
|
1935
|
-
* @type {string}
|
|
1936
|
-
* @memberof GenerateRequestDto
|
|
1937
|
-
*/
|
|
1938
|
-
'pubKey'?: string;
|
|
1939
2111
|
/**
|
|
1940
2112
|
* Grants 3 types of access to the request: 1. READ access to request detail, credentials, and corresponding evidences. 2. Allows to create Verifiable Presentations (VPs) from mandates associated with this request 3. Allows to verify Verifiable Presentations (VPs) from mandates associated with this request By default, the requester DID are automatically appended to this list.
|
|
1941
2113
|
* @type {Array<string>}
|
|
1942
2114
|
* @memberof GenerateRequestDto
|
|
1943
2115
|
*/
|
|
1944
2116
|
'authorizedDIDs'?: Array<string>;
|
|
1945
|
-
/**
|
|
1946
|
-
* List of known document IDs of the users This will force a KYC verification for each user if none of its Humanos identities match the document ID Will make sure the received identity from the KYC verification matches the document ID, and update the user\'s Humanos identities if needed
|
|
1947
|
-
* @type {Array<string>}
|
|
1948
|
-
* @memberof GenerateRequestDto
|
|
1949
|
-
*/
|
|
1950
|
-
'expectedDocIds'?: Array<string>;
|
|
1951
2117
|
}
|
|
1952
2118
|
declare const GenerateRequestDtoSecurityLevelEnum: {
|
|
1953
2119
|
readonly Contact: "CONTACT";
|
|
@@ -1987,11 +2153,11 @@ interface GenerateSubjectEntity {
|
|
|
1987
2153
|
*/
|
|
1988
2154
|
'id': string;
|
|
1989
2155
|
/**
|
|
1990
|
-
*
|
|
2156
|
+
* Secondary contact (phone or email) used in 2FA mode to receive the signing link.
|
|
1991
2157
|
* @type {string}
|
|
1992
2158
|
* @memberof GenerateSubjectEntity
|
|
1993
2159
|
*/
|
|
1994
|
-
'
|
|
2160
|
+
'secondaryContact'?: string;
|
|
1995
2161
|
/**
|
|
1996
2162
|
* Link to the subject-OTP link. Only present if the issuer is configured to not send the OTP.
|
|
1997
2163
|
* @type {string}
|
|
@@ -2091,7 +2257,6 @@ declare const ResourceMinimalEntityTypeEnum: {
|
|
|
2091
2257
|
readonly Form: "FORM";
|
|
2092
2258
|
readonly Document: "DOCUMENT";
|
|
2093
2259
|
readonly Json: "JSON";
|
|
2094
|
-
readonly Payment: "PAYMENT";
|
|
2095
2260
|
readonly Policy: "POLICY";
|
|
2096
2261
|
};
|
|
2097
2262
|
type ResourceMinimalEntityTypeEnum = typeof ResourceMinimalEntityTypeEnum[keyof typeof ResourceMinimalEntityTypeEnum];
|
|
@@ -2207,30 +2372,12 @@ interface IdentityEventDecision {
|
|
|
2207
2372
|
* @memberof IdentityEventDecision
|
|
2208
2373
|
*/
|
|
2209
2374
|
'success': boolean;
|
|
2210
|
-
/**
|
|
2211
|
-
*
|
|
2212
|
-
* @type {boolean}
|
|
2213
|
-
* @memberof IdentityEventDecision
|
|
2214
|
-
*/
|
|
2215
|
-
'isFraud': boolean;
|
|
2216
|
-
/**
|
|
2217
|
-
*
|
|
2218
|
-
* @type {number}
|
|
2219
|
-
* @memberof IdentityEventDecision
|
|
2220
|
-
*/
|
|
2221
|
-
'riskScore'?: number;
|
|
2222
2375
|
/**
|
|
2223
2376
|
*
|
|
2224
2377
|
* @type {string}
|
|
2225
2378
|
* @memberof IdentityEventDecision
|
|
2226
2379
|
*/
|
|
2227
2380
|
'message'?: string;
|
|
2228
|
-
/**
|
|
2229
|
-
*
|
|
2230
|
-
* @type {string}
|
|
2231
|
-
* @memberof IdentityEventDecision
|
|
2232
|
-
*/
|
|
2233
|
-
'outcome'?: string;
|
|
2234
2381
|
/**
|
|
2235
2382
|
*
|
|
2236
2383
|
* @type {string}
|
|
@@ -2290,67 +2437,117 @@ interface IdentityEventUser {
|
|
|
2290
2437
|
/**
|
|
2291
2438
|
*
|
|
2292
2439
|
* @export
|
|
2293
|
-
* @interface
|
|
2440
|
+
* @interface IdentityWebhookIssueDate
|
|
2441
|
+
*/
|
|
2442
|
+
interface IdentityWebhookIssueDate {
|
|
2443
|
+
}
|
|
2444
|
+
|
|
2445
|
+
/**
|
|
2446
|
+
* Humanos API
|
|
2447
|
+
* Humanos API
|
|
2448
|
+
*
|
|
2449
|
+
* The version of the OpenAPI document: 1.0
|
|
2450
|
+
*
|
|
2451
|
+
*
|
|
2452
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2453
|
+
* https://openapi-generator.tech
|
|
2454
|
+
* Do not edit the class manually.
|
|
2455
|
+
*/
|
|
2456
|
+
|
|
2457
|
+
/**
|
|
2458
|
+
*
|
|
2459
|
+
* @export
|
|
2460
|
+
* @interface IdentityWebhook
|
|
2294
2461
|
*/
|
|
2295
|
-
interface
|
|
2462
|
+
interface IdentityWebhook {
|
|
2296
2463
|
/**
|
|
2297
2464
|
*
|
|
2298
2465
|
* @type {string}
|
|
2299
|
-
* @memberof
|
|
2466
|
+
* @memberof IdentityWebhook
|
|
2300
2467
|
*/
|
|
2301
|
-
'
|
|
2468
|
+
'nationality'?: string;
|
|
2302
2469
|
/**
|
|
2303
2470
|
*
|
|
2304
2471
|
* @type {string}
|
|
2305
|
-
* @memberof
|
|
2472
|
+
* @memberof IdentityWebhook
|
|
2473
|
+
*/
|
|
2474
|
+
'placeOfBirth'?: string;
|
|
2475
|
+
/**
|
|
2476
|
+
*
|
|
2477
|
+
* @type {Array<string>}
|
|
2478
|
+
* @memberof IdentityWebhook
|
|
2306
2479
|
*/
|
|
2307
|
-
'
|
|
2480
|
+
'addresses'?: Array<string>;
|
|
2481
|
+
/**
|
|
2482
|
+
*
|
|
2483
|
+
* @type {number}
|
|
2484
|
+
* @memberof IdentityWebhook
|
|
2485
|
+
*/
|
|
2486
|
+
'height'?: number;
|
|
2487
|
+
/**
|
|
2488
|
+
*
|
|
2489
|
+
* @type {number}
|
|
2490
|
+
* @memberof IdentityWebhook
|
|
2491
|
+
*/
|
|
2492
|
+
'weight'?: number;
|
|
2308
2493
|
/**
|
|
2309
2494
|
*
|
|
2310
2495
|
* @type {string}
|
|
2311
|
-
* @memberof
|
|
2496
|
+
* @memberof IdentityWebhook
|
|
2312
2497
|
*/
|
|
2313
|
-
'
|
|
2498
|
+
'documentType'?: string;
|
|
2499
|
+
/**
|
|
2500
|
+
*
|
|
2501
|
+
* @type {IdentityWebhookIssueDate}
|
|
2502
|
+
* @memberof IdentityWebhook
|
|
2503
|
+
*/
|
|
2504
|
+
'issueDate'?: IdentityWebhookIssueDate;
|
|
2505
|
+
/**
|
|
2506
|
+
*
|
|
2507
|
+
* @type {IdentityWebhookIssueDate}
|
|
2508
|
+
* @memberof IdentityWebhook
|
|
2509
|
+
*/
|
|
2510
|
+
'expiresAt'?: IdentityWebhookIssueDate;
|
|
2314
2511
|
/**
|
|
2315
2512
|
*
|
|
2316
2513
|
* @type {string}
|
|
2317
|
-
* @memberof
|
|
2514
|
+
* @memberof IdentityWebhook
|
|
2318
2515
|
*/
|
|
2319
|
-
'
|
|
2516
|
+
'placeOfIssue'?: string;
|
|
2320
2517
|
/**
|
|
2321
2518
|
*
|
|
2322
2519
|
* @type {string}
|
|
2323
|
-
* @memberof
|
|
2520
|
+
* @memberof IdentityWebhook
|
|
2324
2521
|
*/
|
|
2325
|
-
'
|
|
2522
|
+
'fullName': string;
|
|
2326
2523
|
/**
|
|
2327
2524
|
*
|
|
2328
2525
|
* @type {string}
|
|
2329
|
-
* @memberof
|
|
2526
|
+
* @memberof IdentityWebhook
|
|
2330
2527
|
*/
|
|
2331
|
-
'
|
|
2528
|
+
'gender'?: string;
|
|
2332
2529
|
/**
|
|
2333
2530
|
*
|
|
2334
2531
|
* @type {string}
|
|
2335
|
-
* @memberof
|
|
2532
|
+
* @memberof IdentityWebhook
|
|
2336
2533
|
*/
|
|
2337
|
-
'
|
|
2534
|
+
'birth': string;
|
|
2338
2535
|
/**
|
|
2339
2536
|
*
|
|
2340
2537
|
* @type {string}
|
|
2341
|
-
* @memberof
|
|
2538
|
+
* @memberof IdentityWebhook
|
|
2342
2539
|
*/
|
|
2343
|
-
'
|
|
2540
|
+
'docId': string;
|
|
2344
2541
|
/**
|
|
2345
2542
|
*
|
|
2346
2543
|
* @type {string}
|
|
2347
|
-
* @memberof
|
|
2544
|
+
* @memberof IdentityWebhook
|
|
2348
2545
|
*/
|
|
2349
|
-
'
|
|
2546
|
+
'fullDocId': string;
|
|
2350
2547
|
/**
|
|
2351
2548
|
*
|
|
2352
2549
|
* @type {string}
|
|
2353
|
-
* @memberof
|
|
2550
|
+
* @memberof IdentityWebhook
|
|
2354
2551
|
*/
|
|
2355
2552
|
'countryAlpha3': string;
|
|
2356
2553
|
}
|
|
@@ -2412,21 +2609,157 @@ interface IdentityEvent {
|
|
|
2412
2609
|
'api_version': string;
|
|
2413
2610
|
/**
|
|
2414
2611
|
*
|
|
2415
|
-
* @type {
|
|
2612
|
+
* @type {IdentityWebhook}
|
|
2416
2613
|
* @memberof IdentityEvent
|
|
2417
2614
|
*/
|
|
2418
|
-
'identity'?:
|
|
2615
|
+
'identity'?: IdentityWebhook;
|
|
2419
2616
|
/**
|
|
2420
2617
|
*
|
|
2421
2618
|
* @type {IdentityEventDecision}
|
|
2422
2619
|
* @memberof IdentityEvent
|
|
2423
2620
|
*/
|
|
2424
|
-
'decision': IdentityEventDecision;
|
|
2621
|
+
'decision': IdentityEventDecision;
|
|
2622
|
+
}
|
|
2623
|
+
declare const IdentityEventEventTypeEnum: {
|
|
2624
|
+
readonly Identity: "identity";
|
|
2625
|
+
};
|
|
2626
|
+
type IdentityEventEventTypeEnum = typeof IdentityEventEventTypeEnum[keyof typeof IdentityEventEventTypeEnum];
|
|
2627
|
+
|
|
2628
|
+
/**
|
|
2629
|
+
* Humanos API
|
|
2630
|
+
* Humanos API
|
|
2631
|
+
*
|
|
2632
|
+
* The version of the OpenAPI document: 1.0
|
|
2633
|
+
*
|
|
2634
|
+
*
|
|
2635
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2636
|
+
* https://openapi-generator.tech
|
|
2637
|
+
* Do not edit the class manually.
|
|
2638
|
+
*/
|
|
2639
|
+
/**
|
|
2640
|
+
*
|
|
2641
|
+
* @export
|
|
2642
|
+
* @interface MandateAction
|
|
2643
|
+
*/
|
|
2644
|
+
interface MandateAction {
|
|
2645
|
+
[key: string]: any;
|
|
2646
|
+
/**
|
|
2647
|
+
*
|
|
2648
|
+
* @type {string}
|
|
2649
|
+
* @memberof MandateAction
|
|
2650
|
+
*/
|
|
2651
|
+
'id': string;
|
|
2652
|
+
/**
|
|
2653
|
+
*
|
|
2654
|
+
* @type {string}
|
|
2655
|
+
* @memberof MandateAction
|
|
2656
|
+
*/
|
|
2657
|
+
'digestSRI': string;
|
|
2658
|
+
/**
|
|
2659
|
+
*
|
|
2660
|
+
* @type {string}
|
|
2661
|
+
* @memberof MandateAction
|
|
2662
|
+
*/
|
|
2663
|
+
'location': string;
|
|
2664
|
+
}
|
|
2665
|
+
|
|
2666
|
+
/**
|
|
2667
|
+
* Humanos API
|
|
2668
|
+
* Humanos API
|
|
2669
|
+
*
|
|
2670
|
+
* The version of the OpenAPI document: 1.0
|
|
2671
|
+
*
|
|
2672
|
+
*
|
|
2673
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2674
|
+
* https://openapi-generator.tech
|
|
2675
|
+
* Do not edit the class manually.
|
|
2676
|
+
*/
|
|
2677
|
+
/**
|
|
2678
|
+
*
|
|
2679
|
+
* @export
|
|
2680
|
+
* @interface MandateContext
|
|
2681
|
+
*/
|
|
2682
|
+
interface MandateContext {
|
|
2683
|
+
[key: string]: any;
|
|
2684
|
+
/**
|
|
2685
|
+
*
|
|
2686
|
+
* @type {Array<string>}
|
|
2687
|
+
* @memberof MandateContext
|
|
2688
|
+
*/
|
|
2689
|
+
'authorizedDIDs': Array<string>;
|
|
2690
|
+
}
|
|
2691
|
+
|
|
2692
|
+
/**
|
|
2693
|
+
* Humanos API
|
|
2694
|
+
* Humanos API
|
|
2695
|
+
*
|
|
2696
|
+
* The version of the OpenAPI document: 1.0
|
|
2697
|
+
*
|
|
2698
|
+
*
|
|
2699
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2700
|
+
* https://openapi-generator.tech
|
|
2701
|
+
* Do not edit the class manually.
|
|
2702
|
+
*/
|
|
2703
|
+
/**
|
|
2704
|
+
*
|
|
2705
|
+
* @export
|
|
2706
|
+
* @interface MandateGrantor
|
|
2707
|
+
*/
|
|
2708
|
+
interface MandateGrantor {
|
|
2709
|
+
}
|
|
2710
|
+
|
|
2711
|
+
/**
|
|
2712
|
+
* Humanos API
|
|
2713
|
+
* Humanos API
|
|
2714
|
+
*
|
|
2715
|
+
* The version of the OpenAPI document: 1.0
|
|
2716
|
+
*
|
|
2717
|
+
*
|
|
2718
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2719
|
+
* https://openapi-generator.tech
|
|
2720
|
+
* Do not edit the class manually.
|
|
2721
|
+
*/
|
|
2722
|
+
|
|
2723
|
+
/**
|
|
2724
|
+
*
|
|
2725
|
+
* @export
|
|
2726
|
+
* @interface Mandate
|
|
2727
|
+
*/
|
|
2728
|
+
interface Mandate {
|
|
2729
|
+
[key: string]: any;
|
|
2730
|
+
/**
|
|
2731
|
+
*
|
|
2732
|
+
* @type {MandateGrantor}
|
|
2733
|
+
* @memberof Mandate
|
|
2734
|
+
*/
|
|
2735
|
+
'grantor': MandateGrantor;
|
|
2736
|
+
/**
|
|
2737
|
+
*
|
|
2738
|
+
* @type {string}
|
|
2739
|
+
* @memberof Mandate
|
|
2740
|
+
*/
|
|
2741
|
+
'scope': string;
|
|
2742
|
+
/**
|
|
2743
|
+
*
|
|
2744
|
+
* @type {MandateContext}
|
|
2745
|
+
* @memberof Mandate
|
|
2746
|
+
*/
|
|
2747
|
+
'context': MandateContext;
|
|
2748
|
+
/**
|
|
2749
|
+
*
|
|
2750
|
+
* @type {MandateAction}
|
|
2751
|
+
* @memberof Mandate
|
|
2752
|
+
*/
|
|
2753
|
+
'action'?: MandateAction;
|
|
2754
|
+
/**
|
|
2755
|
+
*
|
|
2756
|
+
* @type {{ [key: string]: any; }}
|
|
2757
|
+
* @memberof Mandate
|
|
2758
|
+
*/
|
|
2759
|
+
'userParams'?: {
|
|
2760
|
+
[key: string]: any;
|
|
2761
|
+
};
|
|
2425
2762
|
}
|
|
2426
|
-
declare const IdentityEventEventTypeEnum: {
|
|
2427
|
-
readonly Identity: "identity";
|
|
2428
|
-
};
|
|
2429
|
-
type IdentityEventEventTypeEnum = typeof IdentityEventEventTypeEnum[keyof typeof IdentityEventEventTypeEnum];
|
|
2430
2763
|
|
|
2431
2764
|
/**
|
|
2432
2765
|
* Humanos API
|
|
@@ -2629,19 +2962,25 @@ interface ReceiptEntity {
|
|
|
2629
2962
|
/**
|
|
2630
2963
|
*
|
|
2631
2964
|
* @export
|
|
2632
|
-
* @interface
|
|
2965
|
+
* @interface PresentationEntity
|
|
2633
2966
|
*/
|
|
2634
|
-
interface
|
|
2967
|
+
interface PresentationEntity {
|
|
2635
2968
|
/**
|
|
2636
|
-
* Signed W3C Verifiable Presentation
|
|
2969
|
+
* Signed W3C Verifiable Presentation (@context, type, holder, verifiableCredential, proof), exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Provide this or `presentationEncoded` (at least one is required; `presentationEncoded` overrides and is recommended, since a base64 string avoids JSON formatting changes that can break the signature).
|
|
2637
2970
|
* @type {object}
|
|
2638
|
-
* @memberof
|
|
2971
|
+
* @memberof PresentationEntity
|
|
2639
2972
|
*/
|
|
2640
2973
|
'presentation': object;
|
|
2974
|
+
/**
|
|
2975
|
+
* Base64-encoded JSON of the signed Verifiable Presentation above. Pass it back to POST /credential/verify as `presentationEncoded` (recommended) to avoid signature failures caused by JSON re-serialization in some HTTP clients.
|
|
2976
|
+
* @type {string}
|
|
2977
|
+
* @memberof PresentationEntity
|
|
2978
|
+
*/
|
|
2979
|
+
'presentationEncoded': string;
|
|
2641
2980
|
/**
|
|
2642
2981
|
* VP_CREATED receipt issued for this presentation
|
|
2643
2982
|
* @type {ReceiptEntity}
|
|
2644
|
-
* @memberof
|
|
2983
|
+
* @memberof PresentationEntity
|
|
2645
2984
|
*/
|
|
2646
2985
|
'receipt': ReceiptEntity;
|
|
2647
2986
|
}
|
|
@@ -2776,6 +3115,12 @@ interface RequestDetailSubjectEntity {
|
|
|
2776
3115
|
* @memberof RequestDetailSubjectEntity
|
|
2777
3116
|
*/
|
|
2778
3117
|
'kyc'?: string;
|
|
3118
|
+
/**
|
|
3119
|
+
* Secondary contact (email or phone) used for two-factor authentication in this request. Present when the request was created with a secondary contact for 2FA.
|
|
3120
|
+
* @type {string}
|
|
3121
|
+
* @memberof RequestDetailSubjectEntity
|
|
3122
|
+
*/
|
|
3123
|
+
'secondaryContact'?: string;
|
|
2779
3124
|
}
|
|
2780
3125
|
declare const RequestDetailSubjectEntityIdentityStatusEnum: {
|
|
2781
3126
|
readonly None: "NONE";
|
|
@@ -2918,6 +3263,12 @@ interface RequestSubjectEntity {
|
|
|
2918
3263
|
* @memberof RequestSubjectEntity
|
|
2919
3264
|
*/
|
|
2920
3265
|
'kyc'?: string;
|
|
3266
|
+
/**
|
|
3267
|
+
* Secondary contact (email or phone) used for two-factor authentication in this request. Present when the request was created with a secondary contact for 2FA.
|
|
3268
|
+
* @type {string}
|
|
3269
|
+
* @memberof RequestSubjectEntity
|
|
3270
|
+
*/
|
|
3271
|
+
'secondaryContact'?: string;
|
|
2921
3272
|
}
|
|
2922
3273
|
declare const RequestSubjectEntityIdentityStatusEnum: {
|
|
2923
3274
|
readonly None: "NONE";
|
|
@@ -3124,6 +3475,80 @@ interface RequestsCreate400Response {
|
|
|
3124
3475
|
'error'?: string;
|
|
3125
3476
|
}
|
|
3126
3477
|
|
|
3478
|
+
/**
|
|
3479
|
+
* Humanos API
|
|
3480
|
+
* Humanos API
|
|
3481
|
+
*
|
|
3482
|
+
* The version of the OpenAPI document: 1.0
|
|
3483
|
+
*
|
|
3484
|
+
*
|
|
3485
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3486
|
+
* https://openapi-generator.tech
|
|
3487
|
+
* Do not edit the class manually.
|
|
3488
|
+
*/
|
|
3489
|
+
/**
|
|
3490
|
+
*
|
|
3491
|
+
* @export
|
|
3492
|
+
* @interface RequestsCreate402Response
|
|
3493
|
+
*/
|
|
3494
|
+
interface RequestsCreate402Response {
|
|
3495
|
+
/**
|
|
3496
|
+
*
|
|
3497
|
+
* @type {number}
|
|
3498
|
+
* @memberof RequestsCreate402Response
|
|
3499
|
+
*/
|
|
3500
|
+
'statusCode'?: number;
|
|
3501
|
+
/**
|
|
3502
|
+
*
|
|
3503
|
+
* @type {string}
|
|
3504
|
+
* @memberof RequestsCreate402Response
|
|
3505
|
+
*/
|
|
3506
|
+
'message'?: string;
|
|
3507
|
+
/**
|
|
3508
|
+
*
|
|
3509
|
+
* @type {string}
|
|
3510
|
+
* @memberof RequestsCreate402Response
|
|
3511
|
+
*/
|
|
3512
|
+
'error'?: string;
|
|
3513
|
+
}
|
|
3514
|
+
|
|
3515
|
+
/**
|
|
3516
|
+
* Humanos API
|
|
3517
|
+
* Humanos API
|
|
3518
|
+
*
|
|
3519
|
+
* The version of the OpenAPI document: 1.0
|
|
3520
|
+
*
|
|
3521
|
+
*
|
|
3522
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3523
|
+
* https://openapi-generator.tech
|
|
3524
|
+
* Do not edit the class manually.
|
|
3525
|
+
*/
|
|
3526
|
+
/**
|
|
3527
|
+
*
|
|
3528
|
+
* @export
|
|
3529
|
+
* @interface RequestsCreate409Response
|
|
3530
|
+
*/
|
|
3531
|
+
interface RequestsCreate409Response {
|
|
3532
|
+
/**
|
|
3533
|
+
*
|
|
3534
|
+
* @type {number}
|
|
3535
|
+
* @memberof RequestsCreate409Response
|
|
3536
|
+
*/
|
|
3537
|
+
'statusCode'?: number;
|
|
3538
|
+
/**
|
|
3539
|
+
*
|
|
3540
|
+
* @type {string}
|
|
3541
|
+
* @memberof RequestsCreate409Response
|
|
3542
|
+
*/
|
|
3543
|
+
'message'?: string;
|
|
3544
|
+
/**
|
|
3545
|
+
*
|
|
3546
|
+
* @type {string}
|
|
3547
|
+
* @memberof RequestsCreate409Response
|
|
3548
|
+
*/
|
|
3549
|
+
'error'?: string;
|
|
3550
|
+
}
|
|
3551
|
+
|
|
3127
3552
|
/**
|
|
3128
3553
|
* Humanos API
|
|
3129
3554
|
* Humanos API
|
|
@@ -3319,7 +3744,6 @@ declare const ResourceEntityTypeEnum: {
|
|
|
3319
3744
|
readonly Form: "FORM";
|
|
3320
3745
|
readonly Document: "DOCUMENT";
|
|
3321
3746
|
readonly Json: "JSON";
|
|
3322
|
-
readonly Payment: "PAYMENT";
|
|
3323
3747
|
readonly Policy: "POLICY";
|
|
3324
3748
|
};
|
|
3325
3749
|
type ResourceEntityTypeEnum = typeof ResourceEntityTypeEnum[keyof typeof ResourceEntityTypeEnum];
|
|
@@ -3383,7 +3807,6 @@ declare const ResourceQueryTypesEnum: {
|
|
|
3383
3807
|
readonly Form: "FORM";
|
|
3384
3808
|
readonly Document: "DOCUMENT";
|
|
3385
3809
|
readonly Json: "JSON";
|
|
3386
|
-
readonly Payment: "PAYMENT";
|
|
3387
3810
|
readonly Policy: "POLICY";
|
|
3388
3811
|
};
|
|
3389
3812
|
type ResourceQueryTypesEnum = typeof ResourceQueryTypesEnum[keyof typeof ResourceQueryTypesEnum];
|
|
@@ -3456,7 +3879,6 @@ interface RevokeCredentialDto {
|
|
|
3456
3879
|
* https://openapi-generator.tech
|
|
3457
3880
|
* Do not edit the class manually.
|
|
3458
3881
|
*/
|
|
3459
|
-
|
|
3460
3882
|
/**
|
|
3461
3883
|
*
|
|
3462
3884
|
* @export
|
|
@@ -3481,12 +3903,6 @@ interface RevokeCredentialEntity {
|
|
|
3481
3903
|
* @memberof RevokeCredentialEntity
|
|
3482
3904
|
*/
|
|
3483
3905
|
'revokedAt': string;
|
|
3484
|
-
/**
|
|
3485
|
-
* MANDATE_REVOKED receipt issued for this revocation
|
|
3486
|
-
* @type {ReceiptEntity}
|
|
3487
|
-
* @memberof RevokeCredentialEntity
|
|
3488
|
-
*/
|
|
3489
|
-
'receipt': ReceiptEntity;
|
|
3490
3906
|
}
|
|
3491
3907
|
declare const RevokeCredentialEntityStatusEnum: {
|
|
3492
3908
|
readonly Draft: "DRAFT";
|
|
@@ -3969,11 +4385,17 @@ type VerifyDenyResponseEntityDecisionEnum = typeof VerifyDenyResponseEntityDecis
|
|
|
3969
4385
|
*/
|
|
3970
4386
|
interface VerifyPresentationDto {
|
|
3971
4387
|
/**
|
|
3972
|
-
* Signed W3C Verifiable Presentation
|
|
4388
|
+
* Signed W3C Verifiable Presentation (@context, type, holder, verifiableCredential, proof), exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Provide this or `presentationEncoded` (at least one is required; `presentationEncoded` overrides and is recommended, since a base64 string avoids JSON formatting changes that can break the signature).
|
|
3973
4389
|
* @type {object}
|
|
3974
4390
|
* @memberof VerifyPresentationDto
|
|
3975
4391
|
*/
|
|
3976
|
-
'presentation'
|
|
4392
|
+
'presentation'?: object;
|
|
4393
|
+
/**
|
|
4394
|
+
* Base64-encoded JSON of the signed Verifiable Presentation above. Pass it back to POST /credential/verify as `presentationEncoded` (recommended) to avoid signature failures caused by JSON re-serialization in some HTTP clients.
|
|
4395
|
+
* @type {string}
|
|
4396
|
+
* @memberof VerifyPresentationDto
|
|
4397
|
+
*/
|
|
4398
|
+
'presentationEncoded'?: string;
|
|
3977
4399
|
/**
|
|
3978
4400
|
* Params the agent intends to supply when invoking the action. Validated against the action\'s declared `executionParams` shape and exposed to CEL rules as `executionParams.<field>`.
|
|
3979
4401
|
* @type {object}
|
|
@@ -3982,142 +4404,6 @@ interface VerifyPresentationDto {
|
|
|
3982
4404
|
'executionParams'?: object;
|
|
3983
4405
|
}
|
|
3984
4406
|
|
|
3985
|
-
/**
|
|
3986
|
-
* Humanos API
|
|
3987
|
-
* Humanos API
|
|
3988
|
-
*
|
|
3989
|
-
* The version of the OpenAPI document: 1.0
|
|
3990
|
-
*
|
|
3991
|
-
*
|
|
3992
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3993
|
-
* https://openapi-generator.tech
|
|
3994
|
-
* Do not edit the class manually.
|
|
3995
|
-
*/
|
|
3996
|
-
/**
|
|
3997
|
-
*
|
|
3998
|
-
* @export
|
|
3999
|
-
* @interface W3CVerifiableCredentialCredentialSubjectMandateAction
|
|
4000
|
-
*/
|
|
4001
|
-
interface W3CVerifiableCredentialCredentialSubjectMandateAction {
|
|
4002
|
-
[key: string]: any;
|
|
4003
|
-
/**
|
|
4004
|
-
*
|
|
4005
|
-
* @type {string}
|
|
4006
|
-
* @memberof W3CVerifiableCredentialCredentialSubjectMandateAction
|
|
4007
|
-
*/
|
|
4008
|
-
'id': string;
|
|
4009
|
-
/**
|
|
4010
|
-
*
|
|
4011
|
-
* @type {string}
|
|
4012
|
-
* @memberof W3CVerifiableCredentialCredentialSubjectMandateAction
|
|
4013
|
-
*/
|
|
4014
|
-
'digestSRI': string;
|
|
4015
|
-
/**
|
|
4016
|
-
*
|
|
4017
|
-
* @type {string}
|
|
4018
|
-
* @memberof W3CVerifiableCredentialCredentialSubjectMandateAction
|
|
4019
|
-
*/
|
|
4020
|
-
'location': string;
|
|
4021
|
-
}
|
|
4022
|
-
|
|
4023
|
-
/**
|
|
4024
|
-
* Humanos API
|
|
4025
|
-
* Humanos API
|
|
4026
|
-
*
|
|
4027
|
-
* The version of the OpenAPI document: 1.0
|
|
4028
|
-
*
|
|
4029
|
-
*
|
|
4030
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4031
|
-
* https://openapi-generator.tech
|
|
4032
|
-
* Do not edit the class manually.
|
|
4033
|
-
*/
|
|
4034
|
-
/**
|
|
4035
|
-
*
|
|
4036
|
-
* @export
|
|
4037
|
-
* @interface W3CVerifiableCredentialCredentialSubjectMandateContext
|
|
4038
|
-
*/
|
|
4039
|
-
interface W3CVerifiableCredentialCredentialSubjectMandateContext {
|
|
4040
|
-
[key: string]: any;
|
|
4041
|
-
/**
|
|
4042
|
-
*
|
|
4043
|
-
* @type {Array<string>}
|
|
4044
|
-
* @memberof W3CVerifiableCredentialCredentialSubjectMandateContext
|
|
4045
|
-
*/
|
|
4046
|
-
'authorizedDIDs': Array<string>;
|
|
4047
|
-
}
|
|
4048
|
-
|
|
4049
|
-
/**
|
|
4050
|
-
* Humanos API
|
|
4051
|
-
* Humanos API
|
|
4052
|
-
*
|
|
4053
|
-
* The version of the OpenAPI document: 1.0
|
|
4054
|
-
*
|
|
4055
|
-
*
|
|
4056
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4057
|
-
* https://openapi-generator.tech
|
|
4058
|
-
* Do not edit the class manually.
|
|
4059
|
-
*/
|
|
4060
|
-
/**
|
|
4061
|
-
*
|
|
4062
|
-
* @export
|
|
4063
|
-
* @interface W3CVerifiableCredentialCredentialSubjectMandateGrantor
|
|
4064
|
-
*/
|
|
4065
|
-
interface W3CVerifiableCredentialCredentialSubjectMandateGrantor {
|
|
4066
|
-
}
|
|
4067
|
-
|
|
4068
|
-
/**
|
|
4069
|
-
* Humanos API
|
|
4070
|
-
* Humanos API
|
|
4071
|
-
*
|
|
4072
|
-
* The version of the OpenAPI document: 1.0
|
|
4073
|
-
*
|
|
4074
|
-
*
|
|
4075
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4076
|
-
* https://openapi-generator.tech
|
|
4077
|
-
* Do not edit the class manually.
|
|
4078
|
-
*/
|
|
4079
|
-
|
|
4080
|
-
/**
|
|
4081
|
-
*
|
|
4082
|
-
* @export
|
|
4083
|
-
* @interface W3CVerifiableCredentialCredentialSubjectMandate
|
|
4084
|
-
*/
|
|
4085
|
-
interface W3CVerifiableCredentialCredentialSubjectMandate {
|
|
4086
|
-
[key: string]: any;
|
|
4087
|
-
/**
|
|
4088
|
-
*
|
|
4089
|
-
* @type {W3CVerifiableCredentialCredentialSubjectMandateGrantor}
|
|
4090
|
-
* @memberof W3CVerifiableCredentialCredentialSubjectMandate
|
|
4091
|
-
*/
|
|
4092
|
-
'grantor': W3CVerifiableCredentialCredentialSubjectMandateGrantor;
|
|
4093
|
-
/**
|
|
4094
|
-
*
|
|
4095
|
-
* @type {string}
|
|
4096
|
-
* @memberof W3CVerifiableCredentialCredentialSubjectMandate
|
|
4097
|
-
*/
|
|
4098
|
-
'scope': string;
|
|
4099
|
-
/**
|
|
4100
|
-
*
|
|
4101
|
-
* @type {W3CVerifiableCredentialCredentialSubjectMandateContext}
|
|
4102
|
-
* @memberof W3CVerifiableCredentialCredentialSubjectMandate
|
|
4103
|
-
*/
|
|
4104
|
-
'context': W3CVerifiableCredentialCredentialSubjectMandateContext;
|
|
4105
|
-
/**
|
|
4106
|
-
*
|
|
4107
|
-
* @type {W3CVerifiableCredentialCredentialSubjectMandateAction}
|
|
4108
|
-
* @memberof W3CVerifiableCredentialCredentialSubjectMandate
|
|
4109
|
-
*/
|
|
4110
|
-
'action'?: W3CVerifiableCredentialCredentialSubjectMandateAction;
|
|
4111
|
-
/**
|
|
4112
|
-
*
|
|
4113
|
-
* @type {{ [key: string]: any; }}
|
|
4114
|
-
* @memberof W3CVerifiableCredentialCredentialSubjectMandate
|
|
4115
|
-
*/
|
|
4116
|
-
'userParams'?: {
|
|
4117
|
-
[key: string]: any;
|
|
4118
|
-
};
|
|
4119
|
-
}
|
|
4120
|
-
|
|
4121
4407
|
/**
|
|
4122
4408
|
* Humanos API
|
|
4123
4409
|
* Humanos API
|
|
@@ -4145,66 +4431,10 @@ interface W3CVerifiableCredentialCredentialSubject {
|
|
|
4145
4431
|
'id': string;
|
|
4146
4432
|
/**
|
|
4147
4433
|
*
|
|
4148
|
-
* @type {
|
|
4434
|
+
* @type {Mandate}
|
|
4149
4435
|
* @memberof W3CVerifiableCredentialCredentialSubject
|
|
4150
4436
|
*/
|
|
4151
|
-
'mandate':
|
|
4152
|
-
}
|
|
4153
|
-
|
|
4154
|
-
/**
|
|
4155
|
-
* Humanos API
|
|
4156
|
-
* Humanos API
|
|
4157
|
-
*
|
|
4158
|
-
* The version of the OpenAPI document: 1.0
|
|
4159
|
-
*
|
|
4160
|
-
*
|
|
4161
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4162
|
-
* https://openapi-generator.tech
|
|
4163
|
-
* Do not edit the class manually.
|
|
4164
|
-
*/
|
|
4165
|
-
/**
|
|
4166
|
-
*
|
|
4167
|
-
* @export
|
|
4168
|
-
* @interface W3CVerifiableCredentialProofsInner
|
|
4169
|
-
*/
|
|
4170
|
-
interface W3CVerifiableCredentialProofsInner {
|
|
4171
|
-
[key: string]: any;
|
|
4172
|
-
/**
|
|
4173
|
-
*
|
|
4174
|
-
* @type {string}
|
|
4175
|
-
* @memberof W3CVerifiableCredentialProofsInner
|
|
4176
|
-
*/
|
|
4177
|
-
'type': string;
|
|
4178
|
-
/**
|
|
4179
|
-
*
|
|
4180
|
-
* @type {string}
|
|
4181
|
-
* @memberof W3CVerifiableCredentialProofsInner
|
|
4182
|
-
*/
|
|
4183
|
-
'cryptosuite': string;
|
|
4184
|
-
/**
|
|
4185
|
-
*
|
|
4186
|
-
* @type {string}
|
|
4187
|
-
* @memberof W3CVerifiableCredentialProofsInner
|
|
4188
|
-
*/
|
|
4189
|
-
'verificationMethod': string;
|
|
4190
|
-
/**
|
|
4191
|
-
*
|
|
4192
|
-
* @type {string}
|
|
4193
|
-
* @memberof W3CVerifiableCredentialProofsInner
|
|
4194
|
-
*/
|
|
4195
|
-
'created': string;
|
|
4196
|
-
/**
|
|
4197
|
-
*
|
|
4198
|
-
* @type {string}
|
|
4199
|
-
* @memberof W3CVerifiableCredentialProofsInner
|
|
4200
|
-
*/
|
|
4201
|
-
'proofPurpose': string;
|
|
4202
|
-
/**
|
|
4203
|
-
*
|
|
4204
|
-
* @type {string}
|
|
4205
|
-
* @memberof W3CVerifiableCredentialProofsInner
|
|
4206
|
-
*/
|
|
4207
|
-
'proofValue': string;
|
|
4437
|
+
'mandate': Mandate;
|
|
4208
4438
|
}
|
|
4209
4439
|
|
|
4210
4440
|
/**
|
|
@@ -4276,10 +4506,10 @@ interface W3CVerifiableCredential {
|
|
|
4276
4506
|
'evidences': Array<Evidence>;
|
|
4277
4507
|
/**
|
|
4278
4508
|
*
|
|
4279
|
-
* @type {Array<
|
|
4509
|
+
* @type {Array<CredentialProof>}
|
|
4280
4510
|
* @memberof W3CVerifiableCredential
|
|
4281
4511
|
*/
|
|
4282
|
-
'proofs'
|
|
4512
|
+
'proofs'?: Array<CredentialProof>;
|
|
4283
4513
|
}
|
|
4284
4514
|
|
|
4285
4515
|
/**
|
|
@@ -4699,7 +4929,6 @@ declare const ListTypesEnum: {
|
|
|
4699
4929
|
readonly Form: "FORM";
|
|
4700
4930
|
readonly Document: "DOCUMENT";
|
|
4701
4931
|
readonly Json: "JSON";
|
|
4702
|
-
readonly Payment: "PAYMENT";
|
|
4703
4932
|
readonly Policy: "POLICY";
|
|
4704
4933
|
};
|
|
4705
4934
|
type ListTypesEnum = typeof ListTypesEnum[keyof typeof ListTypesEnum];
|
|
@@ -4711,7 +4940,6 @@ declare const WorkflowsTypesEnum: {
|
|
|
4711
4940
|
readonly Form: "FORM";
|
|
4712
4941
|
readonly Document: "DOCUMENT";
|
|
4713
4942
|
readonly Json: "JSON";
|
|
4714
|
-
readonly Payment: "PAYMENT";
|
|
4715
4943
|
readonly Policy: "POLICY";
|
|
4716
4944
|
};
|
|
4717
4945
|
type WorkflowsTypesEnum = typeof WorkflowsTypesEnum[keyof typeof WorkflowsTypesEnum];
|
|
@@ -4742,7 +4970,7 @@ declare const CredentialsApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
4742
4970
|
/**
|
|
4743
4971
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
4744
4972
|
* @summary Issue VP
|
|
4745
|
-
* @param {string} vcId
|
|
4973
|
+
* @param {string} vcId URN of the credential to present.
|
|
4746
4974
|
* @param {CreatePresentationDto} createPresentationDto
|
|
4747
4975
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
4748
4976
|
* @param {*} [options] Override http request option.
|
|
@@ -4750,7 +4978,7 @@ declare const CredentialsApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
4750
4978
|
*/
|
|
4751
4979
|
issueVP: (vcId: string, createPresentationDto: CreatePresentationDto, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4752
4980
|
/**
|
|
4753
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
4981
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
4754
4982
|
* @summary Revoke Credential
|
|
4755
4983
|
* @param {string} credentialId URN of the credential to revoke
|
|
4756
4984
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -4760,7 +4988,7 @@ declare const CredentialsApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
4760
4988
|
*/
|
|
4761
4989
|
revoke: (credentialId: string, aPIVersion?: string, revokeCredentialDto?: RevokeCredentialDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4762
4990
|
/**
|
|
4763
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
4991
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
4764
4992
|
* @summary Verify VP
|
|
4765
4993
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
4766
4994
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -4795,15 +5023,15 @@ declare const CredentialsApiFp: (configuration?: Configuration) => {
|
|
|
4795
5023
|
/**
|
|
4796
5024
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
4797
5025
|
* @summary Issue VP
|
|
4798
|
-
* @param {string} vcId
|
|
5026
|
+
* @param {string} vcId URN of the credential to present.
|
|
4799
5027
|
* @param {CreatePresentationDto} createPresentationDto
|
|
4800
5028
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
4801
5029
|
* @param {*} [options] Override http request option.
|
|
4802
5030
|
* @throws {RequiredError}
|
|
4803
5031
|
*/
|
|
4804
|
-
issueVP(vcId: string, createPresentationDto: CreatePresentationDto, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
5032
|
+
issueVP(vcId: string, createPresentationDto: CreatePresentationDto, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PresentationEntity>>;
|
|
4805
5033
|
/**
|
|
4806
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
5034
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
4807
5035
|
* @summary Revoke Credential
|
|
4808
5036
|
* @param {string} credentialId URN of the credential to revoke
|
|
4809
5037
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -4813,7 +5041,7 @@ declare const CredentialsApiFp: (configuration?: Configuration) => {
|
|
|
4813
5041
|
*/
|
|
4814
5042
|
revoke(credentialId: string, aPIVersion?: string, revokeCredentialDto?: RevokeCredentialDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeCredentialEntity>>;
|
|
4815
5043
|
/**
|
|
4816
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
5044
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
4817
5045
|
* @summary Verify VP
|
|
4818
5046
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
4819
5047
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -4848,15 +5076,15 @@ declare const CredentialsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
4848
5076
|
/**
|
|
4849
5077
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
4850
5078
|
* @summary Issue VP
|
|
4851
|
-
* @param {string} vcId
|
|
5079
|
+
* @param {string} vcId URN of the credential to present.
|
|
4852
5080
|
* @param {CreatePresentationDto} createPresentationDto
|
|
4853
5081
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
4854
5082
|
* @param {*} [options] Override http request option.
|
|
4855
5083
|
* @throws {RequiredError}
|
|
4856
5084
|
*/
|
|
4857
|
-
issueVP(vcId: string, createPresentationDto: CreatePresentationDto, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
5085
|
+
issueVP(vcId: string, createPresentationDto: CreatePresentationDto, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<PresentationEntity>;
|
|
4858
5086
|
/**
|
|
4859
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
5087
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
4860
5088
|
* @summary Revoke Credential
|
|
4861
5089
|
* @param {string} credentialId URN of the credential to revoke
|
|
4862
5090
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -4866,7 +5094,7 @@ declare const CredentialsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
4866
5094
|
*/
|
|
4867
5095
|
revoke(credentialId: string, aPIVersion?: string, revokeCredentialDto?: RevokeCredentialDto, options?: RawAxiosRequestConfig): AxiosPromise<RevokeCredentialEntity>;
|
|
4868
5096
|
/**
|
|
4869
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
5097
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
4870
5098
|
* @summary Verify VP
|
|
4871
5099
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
4872
5100
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -4905,16 +5133,16 @@ declare class CredentialsApi extends BaseAPI {
|
|
|
4905
5133
|
/**
|
|
4906
5134
|
* Build and sign a W3C Verifiable Presentation for a stored credential. The API key must belong to the credential owner.
|
|
4907
5135
|
* @summary Issue VP
|
|
4908
|
-
* @param {string} vcId
|
|
5136
|
+
* @param {string} vcId URN of the credential to present.
|
|
4909
5137
|
* @param {CreatePresentationDto} createPresentationDto
|
|
4910
5138
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
4911
5139
|
* @param {*} [options] Override http request option.
|
|
4912
5140
|
* @throws {RequiredError}
|
|
4913
5141
|
* @memberof CredentialsApi
|
|
4914
5142
|
*/
|
|
4915
|
-
issueVP(vcId: string, createPresentationDto: CreatePresentationDto, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<
|
|
5143
|
+
issueVP(vcId: string, createPresentationDto: CreatePresentationDto, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<PresentationEntity, any, {}>>;
|
|
4916
5144
|
/**
|
|
4917
|
-
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason,
|
|
5145
|
+
* Permanently revoke an active credential. Flips status to REVOKED, records revokedAt and revocationReason, Appends a REVOKE proof to the credential, and emits a MANDATE_REVOKED activity event. Subsequent /vp and /verify calls for this credential are denied with reason credential_revoked.
|
|
4918
5146
|
* @summary Revoke Credential
|
|
4919
5147
|
* @param {string} credentialId URN of the credential to revoke
|
|
4920
5148
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -4925,7 +5153,7 @@ declare class CredentialsApi extends BaseAPI {
|
|
|
4925
5153
|
*/
|
|
4926
5154
|
revoke(credentialId: string, aPIVersion?: string, revokeCredentialDto?: RevokeCredentialDto, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RevokeCredentialEntity, any, {}>>;
|
|
4927
5155
|
/**
|
|
4928
|
-
* Evaluate a VP against runtime context. On allow, returns
|
|
5156
|
+
* Evaluate a VP against runtime context. On allow, returns 201 with the signed receipt. On deny, returns 403 with the reason, evaluations, and receipt in the error body. If the mandate has no constraint schema, only signatures, verifier access, and validity are checked. Supply the presentation exactly as returned by POST /credential/vp/:vcId — do not re-serialize or modify it. Pass it as either `presentation` (the signed VP object) or `presentationEncoded` (its base64 string); at least one is required (400 otherwise), and if both are sent `presentationEncoded` wins. `presentationEncoded` is the recommended field: being an opaque string it is immune to JSON re-serialization / formatting changes (e.g. some HTTP clients reformatting date strings) that would otherwise break the signature.
|
|
4929
5157
|
* @summary Verify VP
|
|
4930
5158
|
* @param {VerifyPresentationDto} verifyPresentationDto
|
|
4931
5159
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -5050,7 +5278,7 @@ declare const RequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5050
5278
|
*/
|
|
5051
5279
|
list: (pageIndex?: number, pageSize?: number, search?: string, dateFrom?: string, dateTo?: string, subject?: string, internalId?: string, securityLevel?: Array<ListSecurityLevelEnum>, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5052
5280
|
/**
|
|
5053
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
5281
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
5054
5282
|
* @summary Resend OTP
|
|
5055
5283
|
* @param {string} requestId Unique identifier of the request.
|
|
5056
5284
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -5113,7 +5341,7 @@ declare const RequestsApiFp: (configuration?: Configuration) => {
|
|
|
5113
5341
|
*/
|
|
5114
5342
|
list(pageIndex?: number, pageSize?: number, search?: string, dateFrom?: string, dateTo?: string, subject?: string, internalId?: string, securityLevel?: Array<ListSecurityLevelEnum>, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestsEntity>>;
|
|
5115
5343
|
/**
|
|
5116
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
5344
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
5117
5345
|
* @summary Resend OTP
|
|
5118
5346
|
* @param {string} requestId Unique identifier of the request.
|
|
5119
5347
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -5176,7 +5404,7 @@ declare const RequestsApiFactory: (configuration?: Configuration, basePath?: str
|
|
|
5176
5404
|
*/
|
|
5177
5405
|
list(pageIndex?: number, pageSize?: number, search?: string, dateFrom?: string, dateTo?: string, subject?: string, internalId?: string, securityLevel?: Array<ListSecurityLevelEnum>, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<RequestsEntity>;
|
|
5178
5406
|
/**
|
|
5179
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
5407
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
5180
5408
|
* @summary Resend OTP
|
|
5181
5409
|
* @param {string} requestId Unique identifier of the request.
|
|
5182
5410
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -5245,7 +5473,7 @@ declare class RequestsApi extends BaseAPI {
|
|
|
5245
5473
|
*/
|
|
5246
5474
|
list(pageIndex?: number, pageSize?: number, search?: string, dateFrom?: string, dateTo?: string, subject?: string, internalId?: string, securityLevel?: Array<ListSecurityLevelEnum>, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RequestsEntity, any, {}>>;
|
|
5247
5475
|
/**
|
|
5248
|
-
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS
|
|
5476
|
+
* Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS. The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
|
|
5249
5477
|
* @summary Resend OTP
|
|
5250
5478
|
* @param {string} requestId Unique identifier of the request.
|
|
5251
5479
|
* @param {string} [contact] Verified contact value (email or phone)
|
|
@@ -5407,7 +5635,7 @@ declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
|
5407
5635
|
*/
|
|
5408
5636
|
identity: (identityEvent: IdentityEvent, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
5409
5637
|
/**
|
|
5410
|
-
* Fired when an OTP delivery to the
|
|
5638
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
5411
5639
|
* @summary OTP Failed Event
|
|
5412
5640
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
5413
5641
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -5449,7 +5677,7 @@ declare const WebhooksApiFp: (configuration?: Configuration) => {
|
|
|
5449
5677
|
*/
|
|
5450
5678
|
identity(identityEvent: IdentityEvent, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
5451
5679
|
/**
|
|
5452
|
-
* Fired when an OTP delivery to the
|
|
5680
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
5453
5681
|
* @summary OTP Failed Event
|
|
5454
5682
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
5455
5683
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -5491,7 +5719,7 @@ declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: str
|
|
|
5491
5719
|
*/
|
|
5492
5720
|
identity(identityEvent: IdentityEvent, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
5493
5721
|
/**
|
|
5494
|
-
* Fired when an OTP delivery to the
|
|
5722
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
5495
5723
|
* @summary OTP Failed Event
|
|
5496
5724
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
5497
5725
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -5537,7 +5765,7 @@ declare class WebhooksApi extends BaseAPI {
|
|
|
5537
5765
|
*/
|
|
5538
5766
|
identity(identityEvent: IdentityEvent, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
|
|
5539
5767
|
/**
|
|
5540
|
-
* Fired when an OTP delivery to the
|
|
5768
|
+
* Fired when an OTP **SMS** could not be delivered: every eligible SMS provider was tried (synchronously or via carrier delivery reports) and none succeeded. Email OTP failures do not emit this event. Carrier delivery reports are asynchronous and occasionally corrected to \"delivered\" afterwards, so treat this event as *Humanos stopped retrying*, not as a guarantee the SMS never arrived. The safe reaction is to `PATCH` the `otp.resendEndpoint` URL exactly as delivered — a resend issues a fresh code and invalidates the old one, so it is harmless even if the original message did arrive late. **Inbound webhook callback** — Humanos POSTs this payload to your registered webhook URL. This is not an endpoint you call; it is documented as a path so SDK code generators emit a typed payload model.
|
|
5541
5769
|
* @summary OTP Failed Event
|
|
5542
5770
|
* @param {OtpFailedEvent} otpFailedEvent
|
|
5543
5771
|
* @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\'s date.
|
|
@@ -5559,7 +5787,7 @@ declare class WebhooksApi extends BaseAPI {
|
|
|
5559
5787
|
}
|
|
5560
5788
|
|
|
5561
5789
|
/** The API version this SDK release is pinned to (YYYY-MM-DD). */
|
|
5562
|
-
declare const API_VERSION = "2026-
|
|
5790
|
+
declare const API_VERSION = "2026-07-07";
|
|
5563
5791
|
/** Identifies this SDK's language in request headers. */
|
|
5564
5792
|
declare const SDK_LANGUAGE = "typescript";
|
|
5565
5793
|
interface HumanosClientConfig {
|
|
@@ -5701,4 +5929,4 @@ declare function processWebhook<T = unknown>(rawBody: string, headers: WebhookHe
|
|
|
5701
5929
|
*/
|
|
5702
5930
|
declare function createWebhookHandler<T = unknown>(config: WebhookConfig, handler: (payload: T) => void | Promise<void>): (req: any, res: any) => Promise<void>;
|
|
5703
5931
|
|
|
5704
|
-
export { API_VERSION, type ActionDto, type ActionEntity, type ActionListEntity, type ActionQuery, type ActionVersionDetailEntity, type ActionVersionListEntity, type ActionVersionSummaryEntity, ActionsApi, ActionsApiAxiosParamCreator, ActionsApiFactory, ActionsApiFp, type ActivitiesEntity, ActivityApi, ActivityApiAxiosParamCreator, ActivityApiFactory, ActivityApiFp, type ActivityEntity, ActivityEntityTypeEnum, type ActivityQuery, ActivityQueryTypeEnum, ApprovalApi, ApprovalApiAxiosParamCreator, ApprovalApiFactory, ApprovalApiFp, type CONSENT, Configuration, type ConfigurationParameters, type ContactEntity, type CreatePresentationDto, type CreateSubjectDto, type CreateSubjectEntity, CreateSubjectEntityStatusEnum, type CredentialDto, type CredentialDtoData, CredentialDtoTypeEnum, type CredentialEntity, CredentialEntityStatusEnum, type CredentialEvent, type CredentialEventDecision, CredentialEventEventTypeEnum, type CredentialEventUser, type CredentialPlacementDto, CredentialPlacementDtoTypeEnum, CredentialStatus, CredentialsApi, CredentialsApiAxiosParamCreator, CredentialsApiFactory, CredentialsApiFp, type CredentialsDetail404Response, type CredentialsEvidence404Response, type CredentialsIssueVP400Response, type CredentialsIssueVP403Response, type CredentialsIssueVP404Response, type CredentialsRevoke400Response, type CredentialsRevoke409Response, DIDApi, DIDApiAxiosParamCreator, DIDApiFactory, DIDApiFp, DeliveryActionType, type DidDocumentEntity, type EncryptedPayload, type Evidence, type GenerateCredentialEntity, type GenerateRequestDto, GenerateRequestDtoSecurityLevelEnum, type GenerateRequestEntity, type GenerateSubjectEntity, type GroupEntity, type GroupsEntity, HumanosClient, type HumanosClientConfig, type IdentityDto, type IdentityEvent, type IdentityEventDecision, IdentityEventEventTypeEnum, type IdentityEventUser, type
|
|
5932
|
+
export { API_VERSION, type ActionDto, type ActionEntity, type ActionListEntity, type ActionQuery, type ActionVersionDetailEntity, type ActionVersionListEntity, type ActionVersionSummaryEntity, ActionsApi, ActionsApiAxiosParamCreator, ActionsApiFactory, ActionsApiFp, type ActivitiesEntity, ActivityApi, ActivityApiAxiosParamCreator, ActivityApiFactory, ActivityApiFp, type ActivityEntity, ActivityEntityTypeEnum, type ActivityQuery, ActivityQueryTypeEnum, ApprovalApi, ApprovalApiAxiosParamCreator, ApprovalApiFactory, ApprovalApiFp, type CONSENT, Configuration, type ConfigurationParameters, type ContactEntity, type CreatePresentationDto, type CreateSubjectDto, type CreateSubjectEntity, CreateSubjectEntityStatusEnum, type CredentialDto, type CredentialDtoData, CredentialDtoTypeEnum, type CredentialEntity, CredentialEntityStatusEnum, type CredentialEvent, type CredentialEventDecision, CredentialEventEventTypeEnum, type CredentialEventUser, type CredentialPlacementDto, CredentialPlacementDtoTypeEnum, type CredentialProof, CredentialStatus, CredentialsApi, CredentialsApiAxiosParamCreator, CredentialsApiFactory, CredentialsApiFp, type CredentialsDetail404Response, type CredentialsEvidence404Response, type CredentialsIssueVP400Response, type CredentialsIssueVP403Response, type CredentialsIssueVP404Response, type CredentialsRevoke400Response, type CredentialsRevoke409Response, DIDApi, DIDApiAxiosParamCreator, DIDApiFactory, DIDApiFp, DeliveryActionType, type DidDocumentEntity, type EncryptedPayload, type Evidence, type GenerateCredentialEntity, type GenerateRequestDto, GenerateRequestDtoSecurityLevelEnum, type GenerateRequestEntity, type GenerateRequestIFrameCookieDto, type GenerateRequestIFrameDto, type GenerateRequestUserDto, GenerateRequestUserDtoLanguageEnum, type GenerateSubjectEntity, type GroupEntity, type GroupsEntity, HumanosClient, type HumanosClientConfig, type IdentityDto, type IdentityEvent, type IdentityEventDecision, IdentityEventEventTypeEnum, type IdentityEventUser, type IdentityWebhook, type IdentityWebhookIssueDate, ListSecurityLevelEnum, ListTypeEnum, ListTypesEnum, type Mandate, type MandateAction, type MandateContext, type MandateGrantor, type OrganizationDataEntity, type OtpError, type OtpFailedEvent, OtpFailedEventEventTypeEnum, type OtpFailedEventOtp, type PartialSubjectEntity, type PresentationEntity, type ReceiptEntity, type RequestCredentialEntity, RequestCredentialEntityStatusEnum, type RequestDetailEntity, RequestDetailEntitySecurityLevelEnum, type RequestDetailSubjectEntity, RequestDetailSubjectEntityIdentityStatusEnum, type RequestEntity, RequestEntitySecurityLevelEnum, type RequestQuery, RequestQuerySecurityLevelEnum, type RequestSubjectEntity, RequestSubjectEntityIdentityStatusEnum, RequestsApi, RequestsApiAxiosParamCreator, RequestsApiFactory, RequestsApiFp, type RequestsCreate400Response, type RequestsCreate402Response, type RequestsCreate409Response, type RequestsDetail404Response, type RequestsEntity, type RequestsResendOtp403Response, type ResourceEntity, ResourceEntityTypeEnum, type ResourceMinimalEntity, ResourceMinimalEntityTypeEnum, type ResourceQuery, ResourceQueryTypesEnum, type ResourcesEntity, type RevokeCredentialDto, type RevokeCredentialEntity, RevokeCredentialEntityStatusEnum, SDK_LANGUAGE, type SubjectIssuerEntity, SubjectIssuerEntityIdentityStatusEnum, type SubjectQuery, type SuccessEntity, type TestEvent, TestEventEventTypeEnum, UserApi, UserApiAxiosParamCreator, UserApiFactory, UserApiFp, type UserCreate400Response, type UserDetail400Response, type UserDetail404Response, type VerificationMethodEntity, type VerifyAllowResponseEntity, VerifyAllowResponseEntityDecisionEnum, type VerifyDenyResponseEntity, VerifyDenyResponseEntityDecisionEnum, type VerifyEvaluationEntity, VerifyEvaluationEntityResultEnum, type VerifyPresentationDto, type W3CVerifiableCredential, type W3CVerifiableCredentialCredentialSubject, type WebhookCallEvent, type WebhookConfig, type WebhookHeaders, WebhooksApi, WebhooksApiAxiosParamCreator, WebhooksApiFactory, WebhooksApiFp, WorkflowsTypesEnum, applySignatureInterceptor, createHumanosClient, createSignatureInterceptor, createWebhookHandler, decryptWebhookPayload, generateSignature, processWebhook, verifyWebhookSignature };
|