{
"openapi" : "3.0.1",
"info" : {
"title" : "GIPS User Agent API (GIPS-UA)",
"description" : "GIPS User Agent API for ID-Proofing",
"version" : "3.43.0"
},
"servers" : [ {
"url" : "HOST"
} ],
"tags" : [ {
"name" : "Identity",
"description" : "Identity API"
}, {
"name" : "Configuration Reader",
"description" : "Configuration Reader"
}, {
"name" : "Swagger",
"description" : "Swagger API"
} ],
"paths" : {
"/gips/v1/identities" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Returns identity details based on the correlation ID provided in the header at the time the identity was created.",
"operationId" : "getIdentityFromCorrelationId",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "correlationID",
"in" : "query",
"description" : "Unique identifier for that identity, generated by the client application. \n
Pattern : \"^[0-9a-zA-Z_\\\\-]{1,256}$\" ",
"required" : true,
"schema" : {
"pattern" : "^[0-9a-zA-Z_\\-]{1,256}$",
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Identity"
}
}
}
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Returns identity details based on a unique ID. Parameters allow filtering of returend data.",
"operationId" : "getIdentity",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"description" : "Optional boolean to retrieve a detailed identity.",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "Response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Identity"
}
}
}
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/additional-files" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve additional images list",
"operationId" : "getAdditionalFiles",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "List of all additional images",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AdditionalFile"
}
}
}
}
},
"403" : {
"description" : "Operation forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit additional image to attach to this identity.",
"description" : "Additional images are attached to this identity without ensuring that they are consistent with the identity. Images are present in the proof. Allowed document type are: png, jpg, jpeg",
"operationId" : "submitAdditionalFiles",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/MultipartAdditionalFiles"
}
}
}
},
"responses" : {
"200" : {
"description" : "Additional image has been uploaded successfully",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AdditionalFileStatus"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/additional-files/{fileId}" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the additional image and metadata as multipart/form-data ",
"operationId" : "getAdditionalFile",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fileId",
"in" : "path",
"description" : "The unique identifier generated when the additional image was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Returns the identity additional image. Response as multipart/form-data with 'File' and 'Metadata' part(s)."
},
"404" : {
"description" : "Unknown identity or file ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
},
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/addresses" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Get addresses associated with the identity.",
"operationId" : "getAddresses",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "Identity address data (all, or for a specified period).",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddressesResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit address attributes for the identity. If country is USA, the state should be given as USPS two-letter abbreviation. This request is asynchronous.",
"operationId" : "submitAddresses",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Address data for that identity",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IdentityAddress"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Addresses have been received and will be processed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddressesResponse"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/addresses/{evidenceId}" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Get a specific address related to the identity.",
"operationId" : "getAddress",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
}, {
"name" : "evidenceId",
"in" : "path",
"description" : "The unique identifier generated when the evidence was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Identity addresses.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddressResponse"
}
}
}
},
"404" : {
"description" : "Unknown identity or address identifier."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/adjudications" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Returns a list of pending requests for adjudication for a specific identity, along with their statuses. You can filter by status.",
"operationId" : "getAdjudicationStatusList",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "status",
"in" : "query",
"description" : "If specified, will return only adjudication requests for this specific status (possible values are: PROCESSING, meaning that adjudication is still in progress, or ACCEPTED/REJECTED/TIME_OUT, meaning no decision has been taken and you need to try again). If not specified, the entire adjudication status list will be returned.",
"schema" : {
"type" : "string",
"enum" : [ "TO_PROCESS", "PROCESSING", "UNSURE", "ACCEPTED", "REJECTED", "ERROR", "TIME_OUT" ]
}
} ],
"responses" : {
"200" : {
"description" : "Adjudication status successfully retrieved.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AdjudicationStatus"
}
}
}
}
},
"404" : {
"description" : "Unknown identity ID or bad status supplied as parameter."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/adjudications/{evidenceId}" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the adjudication status of a given evidence.",
"operationId" : "getAdjudicationStatus",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "evidenceId",
"in" : "path",
"description" : "The unique identifier generated when the evidence was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Returns adjudication status.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AdjudicationStatus"
}
}
}
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "Identity" ],
"summary" : "Send evidence for manual adjudication (identity document or portrait). This request is asynchronous.",
"operationId" : "submitAdjudicationRequest",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "evidenceId",
"in" : "path",
"description" : "The unique identifier generated when the evidence was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Adjudication status.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AdjudicationStatus"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID. or evidence"
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/attributes" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve identity attributes for the identity (given names, surname, date of birth, etc.). These attributes may have been pre- filled based on a previous verification transaction.",
"operationId" : "getAttributesList",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "Identity attributes.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AttributesResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit identity attributes to fix OCR errors. In case the names have slight data extraction inaccuracies, the user can correct the automated name extraction and submit it to fix the reference Identity.",
"operationId" : "submitIdentityAttributes",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Identities attributes for thate Identity",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IdentityAttribute"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Identity attributes for this identity",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AttributesResponse"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/attributes/portrait" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the user's portrait capture details and portrait verification results for the identity.",
"operationId" : "getPortrait",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "Returns portrait object.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PortraitResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Identity" ],
"summary" : "Delete the user's portrait image and verification results for that identity.",
"operationId" : "deletePortrait",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Portrait evidence has been deleted successfully."
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/attributes/portrait/capture" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the portrait image capture for this identity.",
"operationId" : "getPortraitCapture",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Returns the portrait image file as multipart/form-data with a part named 'Portrait'."
},
"404" : {
"description" : "Unknown identity identifier or no portrait linked to identity"
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit a portrait of the user for verification. This request is asynchronous.",
"operationId" : "submitPortraitCapture",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/MultipartPortrait"
},
"encoding" : {
"file" : {
"contentType" : "application/pdf, image/png"
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Portrait has been received and will be verified as soon as a reference is available.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SingleStatus"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/attributes/portrait/capture-session" : {
"post" : {
"tags" : [ "Identity" ],
"summary" : "Starts a new live capture video session. This request is synchronous.",
"operationId" : "initLiveness",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "mode",
"in" : "query",
"description" : "Optional string to choice the liveness mode (webSDK or nativeSDK). If empty, the liveness mode by default is webSDK",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The request has been received and will be processed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaseLivenessSingleStatus"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/attributes/portrait/live-capture-session" : {
"post" : {
"tags" : [ "Identity" ],
"summary" : "Starts a new live capture video session. This request is synchronous.",
"operationId" : "initLivenessOld",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "mode",
"in" : "query",
"description" : "Optional string to choice the liveness mode (webSDK or nativeSDK). If empty, the liveness mode by default is webSDK",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "The request has been received and will be processed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LivenessSingleStatus"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
},
"deprecated" : true
}
},
"/gips/v1/identities/{id}/claim" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the claim evidence information after processing",
"operationId" : "getIdClaim",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "Returns the claim evidence information.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IdClaimResponse"
}
}
}
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit ID CLAIM .",
"operationId" : "submitIdClaim",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IdClaimData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Return the Identity Document status.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SingleStatus"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/consents" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the list of consents associated with the identity.",
"operationId" : "getConsents",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "List of consents.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Consent"
}
}
}
}
},
"400" : {
"description" : "Bad request."
},
"403" : {
"description" : "Operation forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit confirmation that user consent has been obtained to perform specific evidence verifications for a given period. Consent is provided for each evidence. The validity period of consent can vary between evidences. A configurable default expiry period is set if none is provided. The list of types of evidence processing that require explicit consent before evidence submission can be configured.",
"operationId" : "submitConsents",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "List of consents to add to the identity.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Consent"
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Return consents added to the identity.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Consent"
}
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/consents/{consentId}" : {
"delete" : {
"tags" : [ "Identity" ],
"summary" : "Delete a specific consent.",
"operationId" : "deleteConsent",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "consentId",
"in" : "path",
"description" : "The unique identifier generated for the consent when it was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Consent has been deleted successfully."
},
"403" : {
"description" : "Operation forbidden."
},
"404" : {
"description" : "Unknown identity or consent ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/contact-details/mobile" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve mobile phone information as part of the contact details for that identity.",
"operationId" : "getMobile",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "Returns the mobile phone information as part of the contact details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContactDetailsResponse"
}
}
}
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit mobile phone information as part of the contact details for that identity",
"operationId" : "submitMobile",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Mobile phone information.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MobileElement"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Contact Details status.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SingleStatus"
}
}
}
},
"400" : {
"description" : "Bad request or duplicate.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/contact-details/mobile/otp" : {
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit the one time passcode to confirm that the user is in control of the mobile phone line.",
"operationId" : "submitMobileOTP",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "One time passcode used to check mobile of the identity.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OTP"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "OTP received successfully."
},
"400" : {
"description" : "Bad request, or bad passcode value, or verification service check unavailable.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/context" : {
"put" : {
"tags" : [ "Identity" ],
"summary" : "Update the identity's context.",
"operationId" : "updateIdentityContext",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Creation and use of the identity context.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ContextElement"
}
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "IdentityContext has been updated"
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/evidences/{evidenceId}/status" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Get status and errors for a given evidence.",
"operationId" : "getEvidenceStatusByID",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "evidenceId",
"in" : "path",
"description" : "The unique identifier generated when the evidence was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Evidence status",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EvidenceStatus"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/id-document/aus/medicare" : {
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit medicare card attributes for verification.. Card type may be G, B, or Y.",
"operationId" : "submitMedicare",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MedicareData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Return the identity document status.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SingleStatus"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/id-document/aus/medicare/{evidenceId}" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the medicare evidence information after processing",
"operationId" : "getMedicare",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
}, {
"name" : "evidenceId",
"in" : "path",
"description" : "The unique identifier generated when the evidence was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Returns medicare information.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MedicareResponse"
}
}
}
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/id-documents" : {
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit ID document details for verification. Document type may be Passport, Identity Card, Residency Card, Driver's License, Tax ID Card, or Voter ID Card.",
"operationId" : "submitIdDocument",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IdDocumentData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Return the identity document status.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SingleStatus"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/id-documents/capture" : {
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit pictures of an identity document for verification. This request is asynchronous.",
"operationId" : "submitIdDocumentCapture",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/MultipartDocumentCapture"
},
"encoding" : {
"file" : {
"contentType" : "application/pdf, image/png"
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Identity document evidence has been received and will be processed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SingleStatus"
}
}
}
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/id-documents/live-capture-session" : {
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit live capture document session. This request is asynchronous.",
"operationId" : "submitLiveCaptureSession",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Live capture session",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LiveCaptureSession"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Identity document evidence has been received and will be processed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LiveCaptureStatus"
}
}
}
},
"400" : {
"description" : "Bad request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Not allowed"
},
"404" : {
"description" : "Unknown identity identifier"
},
"429" : {
"description" : "The requested service is not available due to too many requests."
},
"500" : {
"description" : "Unexpected error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/id-documents/nfc-session" : {
"post" : {
"tags" : [ "Identity" ],
"summary" : "Submit mrz of an identity document for creating an NFC reading session. This request is asynchronous.",
"operationId" : "submitMrzForNfcSession",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Mrz of the ID document",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Mrz"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Identity document evidence has been received and will be processed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/NfcSessionStatus"
}
}
}
},
"400" : {
"description" : "Bad request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Not allowed"
},
"404" : {
"description" : "Unknown identity identifier"
},
"429" : {
"description" : "Too many calls in the last period of time. Retry later. This is not applicable for now."
},
"500" : {
"description" : "Unexpected error",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/id-documents/{evidenceId}" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the ID document evidence information after processing.",
"operationId" : "getIdDocument",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
}, {
"name" : "evidenceId",
"in" : "path",
"description" : "The unique identifier generated when the evidence was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Returns evidence information.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IdDocumentResponse"
}
}
}
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Identity" ],
"summary" : "Delete an ID document.",
"operationId" : "deleteIdDocument",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "evidenceId",
"in" : "path",
"description" : "The unique identifier generated when the evidence was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Identity document evidence has been deleted successfully."
},
"403" : {
"description" : "Operation forbidden."
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/id-documents/{evidenceId}/capture" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the captured image of the ID document as multipart/form-data including 'DocumentBack' and/or 'DocumentFront' and possibly 'BestEncodedImage' if image was corrected by OCR service(Crop, Rotate...).",
"operationId" : "getIdDocumentCapture",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
}, {
"name" : "evidenceId",
"in" : "path",
"description" : "The unique identifier generated when the evidence was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Returns the identity document captured image. Response as multipart/form-data with 'DocumentBack' and/or 'DocumentFront' part(s)."
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
},
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/id-documents/{evidenceId}/portrait" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the portrait crop extracted from the ID document as multipart/form-data.",
"operationId" : "getIdDocumentPortraitCrop",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "evidenceId",
"in" : "path",
"description" : "The unique identifier generated when the evidence was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Returns the portrait crop extracted from ID document image file. Response as multipart/form-data."
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/status" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve a summary of the identity's general status and evidence status.",
"operationId" : "getStatus",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Summary of identity status succesfully retrieved.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GlobalStatusResponse"
}
}
}
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/status/{elementId}" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Get status of a specific evidence. Use this API for polling after evidence has been submitted.",
"operationId" : "getStatusByElementId",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "elementId",
"in" : "path",
"description" : "The unique element identifier (whether an evidence or other item) generated when evidence or item (\"element\") was submitted.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Status succesfully retrieved.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SingleStatus"
}
}
}
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/trusted-id-claim/oidc" : {
"post" : {
"tags" : [ "Identity" ],
"summary" : "The endpoint for submitting a Digital Credential as trusted claim evidence to be verified by using the openID Connect protocol for Online authentication.",
"operationId" : "submitTrustedIdClaimOidc",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TrustedIdClaimOidc"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Return the Identity Document status.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SingleStatus"
}
}
}
},
"302" : {
"description" : "Return the url ...."
},
"400" : {
"description" : "Bad request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
},
"403" : {
"description" : "Forbidden."
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/identities/{id}/trusted-id-claims" : {
"get" : {
"tags" : [ "Identity" ],
"summary" : "Retrieve the trusted claim evidence information after processing",
"operationId" : "getTrustedIdClaim",
"parameters" : [ {
"name" : "User-Agent",
"in" : "header",
"description" : "The User-Agent request header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.\n
Backend to backend calls:\n
User-Agent: AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion) \n
\n
Web Browsers calls:\n
User-Agent: <product> / <product-version> <comment>",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier generated for the identity when it was created.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "detailed",
"in" : "query",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "Returns the trusted claim evidence information.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TrustedIdClaimResponse"
}
}
}
},
"404" : {
"description" : "Unknown identity or evidence ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/openapi" : {
"get" : {
"tags" : [ "Swagger" ],
"summary" : "Retrieve the OpenAPI definition in yaml format",
"operationId" : "getSwagger",
"parameters" : [ {
"name" : "type",
"in" : "query",
"description" : "The type of API to retrieve. Possible values are USER_AGENT or RELYING_SERVICE. The default type is RELYING_SERVICE.",
"schema" : {
"type" : "string"
}
}, {
"name" : "format",
"in" : "query",
"description" : "The format of the API to retrieve: YAML or JSON. The default format is YAML.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Retrieve the OpenAPI definition in yaml format successfully"
},
"403" : {
"description" : "Operation not allowed"
},
"404" : {
"description" : "Unable to retrieve the OpenAPI definition"
},
"500" : {
"description" : "Unexpected error"
}
}
}
},
"/gips/v1/supported-evidence/countries" : {
"get" : {
"tags" : [ "Configuration Reader" ],
"summary" : "Get the list of supported evidences for all countries.",
"operationId" : "getSupportedEvidence",
"parameters" : [ {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "List of supported evidence.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SupportedDocumentsResponse"
}
}
}
}
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
},
"/gips/v1/supported-evidence/countries/{countryCode}" : {
"get" : {
"tags" : [ "Configuration Reader" ],
"summary" : "Get the list of supported evidence for a given country.",
"operationId" : "getSupportedEvidenceByCountry",
"parameters" : [ {
"name" : "X-Forwarded-For",
"in" : "header",
"description" : "For future use.",
"schema" : {
"type" : "string"
}
}, {
"name" : "countryCode",
"in" : "path",
"description" : "The country identifier. Uses ISO 3-letter code (ISO 3166-1 alpha-3).",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "List of supported evidences.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SupportedDocumentsResponse"
}
}
}
},
"404" : {
"description" : "Unknown identity ID."
},
"429" : {
"description" : "Too many calls in a given time. Try again later."
},
"500" : {
"description" : "Unexpected error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FailureResponse"
}
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"AdditionalFile" : {
"required" : [ "id", "metadata" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID used to identify the file in the identity",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"metadata" : {
"type" : "array",
"description" : "Contains additional information related to the context it is attached to.",
"example" : [ {
"key" : "NAME",
"value" : "file.jpg"
}, {
"key" : "TYPE",
"value" : "image"
} ],
"items" : {
"$ref" : "#/components/schemas/Metadata"
}
}
},
"description" : "Contains additional information related to the context it is attached to."
},
"AdditionalFileStatus" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID used to identify the additional file.",
"example" : "998cf41c-6d76-45d2-b173-185854dc959f"
}
}
},
"Address" : {
"required" : [ "addressData", "evidenceId", "referenceIds", "submitDateTime", "type" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
},
"referenceIds" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "List of evidence IDs that this address is extracted from.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
}
},
"addressData" : {
"$ref" : "#/components/schemas/AddressData"
}
},
"description" : "Contains all address-related information resulting from the ID proofing process."
},
"AddressData" : {
"required" : [ "city", "country" ],
"type" : "object",
"properties" : {
"streetDetails" : {
"$ref" : "#/components/schemas/StreetDetails"
},
"locality" : {
"maxLength" : 100,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ\\s’‘'-\\.,\\(\\)]*$",
"type" : "string",
"description" : "Subdivision in address.",
"example" : "North End"
},
"postcode" : {
"maxLength" : 50,
"minLength" : 1,
"type" : "string",
"description" : "Postal code or ZIP Code in address. The allowed regular expression depends on the country of the address. For a British address, regex is [A-Z]{1,2}[0-9R][0-9A-Z]?[ -]?[0-9][^CIKMOV\\W\\d]{2}. For an US address, regex is ^[A-Za-z0-9-]*$. Otherwise by default, regex is ^[A-Za-z0-9-]*$",
"example" : "20500"
},
"city" : {
"maxLength" : 100,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ\\s’‘'-\\.,\\(\\)]*$",
"type" : "string",
"description" : "City name in address.",
"example" : "Paris"
},
"county" : {
"maxLength" : 100,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ\\s’‘'-\\.,\\(\\)]*$",
"type" : "string",
"description" : "County name in address (UK).",
"example" : "Kent"
},
"state" : {
"maxLength" : 100,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ\\s’‘'-\\.,\\(\\)]*$",
"type" : "string",
"description" : "If country is USA, state name uses USPS two-letter abbreviations. In all other cases, state name is written in full.",
"example" : "AL"
},
"country" : {
"type" : "string",
"description" : "Contains the ISO 3166-1 alpha-3 code referring to the country of the address.",
"example" : "USA",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CXR", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESP", "EST", "ETH", "EUE", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBD", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MOZ", "MSR", "MRT", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NER", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "RKS", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SHN", "SLB", "SLE", "SLV", "SMR", "SOM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VNM", "VUT", "WSM", "YEM", "ZAF", "ZMB", "ZWE", "UNK", "UNO", "UNA", "XOM", "XXA", "XXB", "XXC", "XXX", "ALA", "BLM", "ESH", "MAF", "MNP", "NCL", "NFK", "REU", "SGS", "SJM", "SPM", "TKL", "UMI", "VIR", "WLF", "BES", "CUW", "CYM", "GUM", "SXM", "ABR" ]
},
"verified" : {
"type" : "boolean",
"description" : "Verification status of this information in AddressData.",
"example" : true
},
"validityperiod" : {
"$ref" : "#/components/schemas/ValidityPeriod"
},
"pollingStation" : {
"maxLength" : 200,
"minLength" : 1,
"pattern" : "^[\\p{L}0-9 @+.’‘'”,\\/\\[\\]\\(\\)\\-]*$",
"type" : "string",
"description" : "Contains the full address of the polling station the user is associated with for this address.",
"example" : "1600 Pennsylvania Ave."
},
"fullAddress" : {
"maxLength" : 200,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ\\s’‘'-\\.,\\(\\)\\/]*$",
"type" : "string",
"description" : "Contains full unstructured address if captured as such.",
"example" : "1600 Pennsylvania Ave. NW, Washington, DC 20500"
}
},
"description" : "Contains all address-related data."
},
"AddressResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"address" : {
"$ref" : "#/components/schemas/Address"
}
}
},
"AddressesResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"addresses" : {
"type" : "array",
"description" : "Contains list of addresses.",
"items" : {
"$ref" : "#/components/schemas/Address"
}
}
}
},
"AdjudicationStatus" : {
"required" : [ "evidenceId" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"type" : {
"type" : "string",
"description" : "The type of adjudication required.",
"example" : "DOCUMENT",
"enum" : [ "FACIAL", "DOCUMENT" ]
},
"status" : {
"type" : "string",
"description" : "Status of the evidence.",
"enum" : [ "TO_PROCESS", "PROCESSING", "UNSURE", "ACCEPTED", "REJECTED", "ERROR", "TIME_OUT" ]
},
"submissionTimeStamp" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted."
}
}
},
"Attributes" : {
"required" : [ "evidenceId", "submitDateTime", "type" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
},
"attributesData" : {
"$ref" : "#/components/schemas/AttributesDataValidity"
}
},
"description" : "Contains all identity attribute-related information resulting from the ID proofing process."
},
"AttributesData" : {
"required" : [ "givenNames", "surname" ],
"type" : "object",
"properties" : {
"allVerified" : {
"type" : "boolean",
"writeOnly" : true
},
"givenNames" : {
"maxItems" : 5,
"minItems" : 1,
"type" : "array",
"description" : "Contains a list of the person's given names.",
"items" : {
"$ref" : "#/components/schemas/NameElement"
}
},
"surname" : {
"$ref" : "#/components/schemas/NameElement"
},
"fullname" : {
"$ref" : "#/components/schemas/NameElement"
},
"nameAtBirth" : {
"$ref" : "#/components/schemas/NameElement"
},
"usageName" : {
"$ref" : "#/components/schemas/NameElement"
},
"suffixName" : {
"$ref" : "#/components/schemas/NameElement"
},
"dateOfBirth" : {
"$ref" : "#/components/schemas/DateElement"
},
"placeOfBirth" : {
"$ref" : "#/components/schemas/Element"
},
"gender" : {
"$ref" : "#/components/schemas/GenderElement"
},
"nationality" : {
"$ref" : "#/components/schemas/NationalityElement"
},
"eyeColor" : {
"$ref" : "#/components/schemas/Element"
},
"height" : {
"$ref" : "#/components/schemas/Element"
},
"weight" : {
"$ref" : "#/components/schemas/Element"
},
"personalNumber" : {
"$ref" : "#/components/schemas/PersonalNumberElement"
},
"bloodGroup" : {
"$ref" : "#/components/schemas/Element"
},
"relatives" : {
"type" : "array",
"description" : "Contains a list of the person's relatives.",
"items" : {
"$ref" : "#/components/schemas/Relative"
}
},
"title" : {
"$ref" : "#/components/schemas/Element"
},
"hairColor" : {
"$ref" : "#/components/schemas/Element"
},
"donor" : {
"$ref" : "#/components/schemas/BooleanElement"
},
"veteran" : {
"$ref" : "#/components/schemas/BooleanElement"
},
"metadata" : {
"type" : "array",
"description" : "May contain additional information depending on use case.",
"items" : {
"$ref" : "#/components/schemas/Metadata"
}
}
},
"description" : "This object contains all identity attributes that have been extracted from an identity evidence."
},
"AttributesDataValidity" : {
"required" : [ "givenNames", "surname" ],
"type" : "object",
"properties" : {
"allVerified" : {
"type" : "boolean",
"writeOnly" : true
},
"givenNames" : {
"maxItems" : 5,
"minItems" : 1,
"type" : "array",
"description" : "Contains a list of the person's given names.",
"items" : {
"$ref" : "#/components/schemas/NameElement"
}
},
"surname" : {
"$ref" : "#/components/schemas/NameElement"
},
"fullname" : {
"$ref" : "#/components/schemas/NameElement"
},
"nameAtBirth" : {
"$ref" : "#/components/schemas/NameElement"
},
"usageName" : {
"$ref" : "#/components/schemas/NameElement"
},
"suffixName" : {
"$ref" : "#/components/schemas/NameElement"
},
"dateOfBirth" : {
"$ref" : "#/components/schemas/DateElement"
},
"placeOfBirth" : {
"$ref" : "#/components/schemas/Element"
},
"gender" : {
"$ref" : "#/components/schemas/GenderElement"
},
"nationality" : {
"$ref" : "#/components/schemas/NationalityElement"
},
"eyeColor" : {
"$ref" : "#/components/schemas/Element"
},
"height" : {
"$ref" : "#/components/schemas/Element"
},
"weight" : {
"$ref" : "#/components/schemas/Element"
},
"personalNumber" : {
"$ref" : "#/components/schemas/PersonalNumberElement"
},
"bloodGroup" : {
"$ref" : "#/components/schemas/Element"
},
"relatives" : {
"type" : "array",
"description" : "Contains a list of the person's relatives.",
"items" : {
"$ref" : "#/components/schemas/Relative"
}
},
"title" : {
"$ref" : "#/components/schemas/Element"
},
"hairColor" : {
"$ref" : "#/components/schemas/Element"
},
"donor" : {
"$ref" : "#/components/schemas/BooleanElement"
},
"veteran" : {
"$ref" : "#/components/schemas/BooleanElement"
},
"metadata" : {
"type" : "array",
"description" : "May contain additional information depending on use case.",
"items" : {
"$ref" : "#/components/schemas/Metadata"
}
},
"validityPeriod" : {
"$ref" : "#/components/schemas/ValidityPeriod"
}
},
"description" : "This object contains all identity attributes related to the user. The attributes are extracted from the multiple evidences submitted, and consolidated by the service to provide the most accurate information possible."
},
"AttributesResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"attributes" : {
"type" : "array",
"description" : "Contains all identity attribute-related information resultingfrom the ID proofing process",
"items" : {
"$ref" : "#/components/schemas/Attributes"
}
}
}
},
"BaseLivenessSingleStatus" : {
"required" : [ "status" ],
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "The value of the status.",
"example" : "PROCESSING",
"enum" : [ "VERIFIED", "NOT_VERIFIED", "PROCESSING", "ADJUDICATION", "INVALID" ]
},
"type" : {
"type" : "string",
"description" : "The type of element the status is expressed for.",
"example" : "ID_DOCUMENT",
"default" : "ID_DOCUMENT"
},
"id" : {
"type" : "string",
"description" : "ID used to identify the status.",
"example" : "gips-998cf41c-6d76-45d2-b173-185854dc959f"
},
"errors" : {
"type" : "array",
"description" : "The list of errors associated with the status.",
"items" : {
"$ref" : "#/components/schemas/Error"
}
},
"sessionId" : {
"type" : "string",
"description" : "Unique identifier of the bioserver session"
}
}
},
"BooleanElement" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"value" : {
"type" : "boolean",
"description" : "Value of the parent field."
},
"verified" : {
"type" : "boolean",
"description" : "Describes the verification status of the parent field."
}
},
"description" : "Indicates whether the person is a veteran."
},
"Certificate" : {
"required" : [ "evidenceId", "submitDateTime", "type" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
},
"certificateData" : {
"$ref" : "#/components/schemas/CertificateData"
}
},
"description" : "Contains details of a processed certificate evidence."
},
"CertificateData" : {
"required" : [ "certificateNumber", "issuingCountry", "type" ],
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Contains the type of certificate.",
"example" : "CITIZENSHIP_CERTIFICATE"
},
"certificateNumber" : {
"maxLength" : 20,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9-]*$",
"type" : "string",
"description" : "Card ID as written on the certificate",
"example" : "1654A354C"
},
"personalAttributes" : {
"$ref" : "#/components/schemas/AttributesData"
},
"personalAttributes2" : {
"$ref" : "#/components/schemas/AttributesData"
},
"issuingCountry" : {
"type" : "string",
"description" : "Contains the 3 letter country code defined by ISO 3166-1 referring to the country issuing the health card.",
"example" : "AUS",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CXR", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESP", "EST", "ETH", "EUE", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBD", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MOZ", "MSR", "MRT", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NER", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "RKS", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SHN", "SLB", "SLE", "SLV", "SMR", "SOM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VNM", "VUT", "WSM", "YEM", "ZAF", "ZMB", "ZWE", "UNK", "UNO", "UNA", "XOM", "XXA", "XXB", "XXC", "XXX", "ALA", "BLM", "ESH", "MAF", "MNP", "NCL", "NFK", "REU", "SGS", "SJM", "SPM", "TKL", "UMI", "VIR", "WLF", "BES", "CUW", "CYM", "GUM", "SXM", "ABR" ]
},
"issuingState" : {
"type" : "string",
"description" : "Code of the state that issued the document.",
"example" : "ACT"
},
"issuingDate" : {
"type" : "string",
"description" : "Date on which the certificates was issued.",
"example" : "2018-01-01"
},
"registrationNumber" : {
"type" : "string",
"description" : "Registration number as written on the document.",
"example" : "123456"
},
"registrationYear" : {
"type" : "string",
"description" : "The year on which the document was registred.",
"example" : "2018"
},
"registrationDate" : {
"type" : "string",
"description" : "Date on which the certificates was registred.",
"example" : "2018-01-01"
},
"dateOfEvent" : {
"type" : "string",
"description" : "Date on which event took place.",
"example" : "2018"
},
"metadata" : {
"type" : "array",
"description" : "May contain additional information depending on use case.",
"items" : {
"$ref" : "#/components/schemas/Metadata"
}
}
},
"description" : "Contains data related to certificate document."
},
"Consent" : {
"required" : [ "approved", "type" ],
"type" : "object",
"properties" : {
"consentId" : {
"type" : "string",
"description" : "A unique identifier assigned to the consent.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"approved" : {
"type" : "boolean",
"description" : "Notifies the service that the user consents to the associated proofing process.",
"example" : true
},
"type" : {
"type" : "string",
"description" : "Describes the type of consent.",
"example" : "PORTRAIT",
"enum" : [ "ATTRIBUTES", "ID_DOCUMENT", "TWODDOC", "TAX_SHEET", "UTILITY_BILL", "REMOTE_ID", "PORTRAIT", "ADDRESS", "EMAIL", "EMAIL_OTP", "MOBILE", "MOBILE_OTP", "VISA", "GIV", "ANTIFRAUD", "ID_CLAIM" ]
},
"validityPeriod" : {
"$ref" : "#/components/schemas/ValidityPeriod"
}
}
},
"ContactDetails" : {
"type" : "object",
"properties" : {
"username" : {
"$ref" : "#/components/schemas/Username"
},
"email" : {
"$ref" : "#/components/schemas/EmailElement"
},
"mobile" : {
"$ref" : "#/components/schemas/PhoneElement"
},
"status" : {
"$ref" : "#/components/schemas/ContactDetailsStatus"
}
},
"description" : "Contains contact information associated with the identity."
},
"ContactDetailsResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"contactDetails" : {
"$ref" : "#/components/schemas/ContactDetails"
}
}
},
"ContactDetailsStatus" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Error"
}
},
"blockingIndicators" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Indicator"
}
}
},
"description" : "Contact details status."
},
"ContextElement" : {
"required" : [ "key", "value" ],
"type" : "object",
"properties" : {
"key" : {
"maxLength" : 50,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9_]*$",
"type" : "string"
},
"value" : {
"maxLength" : 1024,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ !@+.’‘'”\\/\\[\\]\\(\\)\\-_]*$",
"type" : "string"
}
}
},
"CreditCardDetails" : {
"required" : [ "cardNumber" ],
"type" : "object",
"properties" : {
"cardNumber" : {
"type" : "string",
"description" : "Credit card number.",
"example" : "1654A354CQSD45G6"
},
"cardType" : {
"type" : "string",
"description" : "Credit card type.",
"example" : "CREDIT",
"enum" : [ "CREDIT", "DEBIT" ]
},
"expiryDate" : {
"type" : "string",
"description" : "Credit card expiration date.",
"format" : "date",
"example" : "2022-02-18"
},
"verified" : {
"type" : "boolean"
}
},
"description" : "Optional and deprecated object - description not available.",
"deprecated" : true
},
"DateElement" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "Date in format yyyy-MM-dd",
"example" : "1960-01-01"
},
"verified" : {
"type" : "boolean",
"description" : "Describes the verification status of the parent field."
}
},
"description" : "Contains date of birth."
},
"DocumentConf" : {
"required" : [ "documentType" ],
"type" : "object",
"properties" : {
"documentType" : {
"type" : "string",
"description" : "The type of document this configuration applies to.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY_CARD", "PASSPORT", "DRIVING_LICENSE", "RESIDENT_CARD", "TAX_CARD", "VOTER_CARD", "ID_DOCUMENT", "VISA", "CERTIFICATE", "ID_CLAIM", "MEDICARE", "WORK_PERMIT" ]
},
"format" : {
"type" : "string",
"description" : "Document format as per ICAO 9303 standard (ID1, ID2, ID3).",
"enum" : [ "ID1", "ID2", "ID3" ]
},
"adjudicationSupported" : {
"type" : "boolean",
"description" : "Flag specifying if the document can be read and approved using adjudication."
},
"issuingSourceValidation" : {
"type" : "boolean",
"description" : "Flag specifying if the document can be verified with a Government Issuer Verification."
},
"liveVideoCaptureSupported" : {
"type" : "boolean",
"description" : "Flag specifying if the document can be captured with a web SDK."
},
"imageProcessingSupported" : {
"type" : "boolean",
"description" : "Flag specifying if the document can be verified with a document authentication service."
},
"sides" : {
"type" : "array",
"description" : "Definitions of supported document sides for a given document type.",
"items" : {
"$ref" : "#/components/schemas/Sides"
}
}
},
"description" : "List of documents supported by the country in the iso3CountryCode field."
},
"Element" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"value" : {
"maxLength" : 100,
"minLength" : 1,
"pattern" : "^[\\p{L}0-9 @+.’‘'”,\\/\\[\\]\\(\\)\\-]*$",
"type" : "string",
"description" : "Value of the parent field.",
"example" : "typeElement"
},
"verified" : {
"type" : "boolean",
"description" : "Describes the verification status of the parent field."
}
},
"description" : "Generic identity element."
},
"EmailElement" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"otp" : {
"$ref" : "#/components/schemas/OTPElement"
},
"value" : {
"maxLength" : 100,
"minLength" : 1,
"pattern" : "^[_A-Za-z0-9-àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ\\+]+(\\.[_A-Za-z0-9-àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ]+)*@[A-Za-z0-9-]+(\\.[A-Za-z0-9]+)*(\\.[A-Za-z]{1,})$",
"type" : "string",
"description" : "Value of the parent field.",
"example" : "typeElement"
},
"verified" : {
"type" : "boolean",
"description" : "Describes the verification status of the parent field."
},
"language" : {
"type" : "string"
},
"system" : {
"type" : "string"
},
"errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Error"
}
}
},
"description" : "Email for contacting user.",
"example" : "John@testemail.com"
},
"Error" : {
"type" : "object",
"properties" : {
"field" : {
"type" : "string",
"description" : "Contains the name of the field that generated the error.",
"example" : "surname"
},
"code" : {
"type" : "string",
"description" : "The product-associated error code specific to the generated error. A complete list of error codes and messages is available in the API Feedback Reference Document on the IDEMIA Digital Portal.",
"example" : "1006"
},
"message" : {
"type" : "string",
"description" : "The error message associated with an error code to help understand the error. A complete list of error codes and messages is available in the API Feedback Reference Document.",
"example" : "A field does not have the good format"
}
},
"description" : "The list of errors."
},
"EvidenceStatus" : {
"required" : [ "status" ],
"type" : "object",
"properties" : {
"evaluationDateTime" : {
"type" : "string",
"description" : "Timestamp of end of evidence evaluation.",
"format" : "date-time"
},
"status" : {
"type" : "string",
"description" : "Status of the submitted evidence.",
"example" : "PROCESSING",
"enum" : [ "VERIFIED", "NOT_VERIFIED", "PROCESSING", "ADJUDICATION", "INVALID" ]
},
"isAdjudicable" : {
"type" : "boolean",
"description" : "States whether the evidence can be sent for adjudication.",
"example" : true
},
"errors" : {
"uniqueItems" : true,
"type" : "array",
"description" : "List of errors associated with an evidence status.",
"items" : {
"$ref" : "#/components/schemas/Error"
}
}
},
"description" : "Current status of the evidence."
},
"FailureResponse" : {
"type" : "object",
"properties" : {
"method" : {
"type" : "string",
"description" : "Indicates the operation type in the failure response.",
"example" : "POST",
"enum" : [ "POST", "GET", "PUT", "DELETE" ]
},
"uri" : {
"type" : "string",
"description" : "The URI that generated the error."
},
"errors" : {
"uniqueItems" : true,
"type" : "array",
"description" : "The list of errors.",
"items" : {
"$ref" : "#/components/schemas/Error"
}
}
}
},
"FraudAnalyzedEvidence" : {
"required" : [ "evidenceId", "evidenceType" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "Evidence ID of fraudulent evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"evidenceType" : {
"type" : "string",
"description" : "The type of document on which the fraud analysiswas performed.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
}
},
"description" : "List of evidences processed during the fraud check."
},
"FraudCheckAuthority" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of the authority providing the fraud check service."
},
"service" : {
"type" : "string",
"description" : "Name of the authority providing the fraud check service."
}
},
"description" : "Contains information about the entity doing the fraud checking."
},
"FraudCheckDetails" : {
"type" : "object",
"properties" : {
"authority" : {
"$ref" : "#/components/schemas/FraudCheckAuthority"
},
"fraudCheckDate" : {
"type" : "string",
"description" : "Timestamp indicating when the fraud check was performed.",
"format" : "date-time"
},
"fraudStatus" : {
"type" : "string",
"description" : "Describes the result of the fraud check.",
"example" : "NOT_FOUND",
"enum" : [ "FOUND", "NOT_FOUND", "UNVERIFIED", "PROCESSING" ]
},
"fraudCheckErrors" : {
"type" : "array",
"description" : "List of potential errors that can occur during fraud checks.",
"items" : {
"$ref" : "#/components/schemas/Error"
}
},
"probeData" : {
"type" : "object",
"additionalProperties" : {
"type" : "string",
"description" : "Data used during fraud check."
},
"description" : "Data used during fraud check."
},
"fraudCheckHitList" : {
"type" : "array",
"description" : "List of potential matches found during fraud check.",
"items" : {
"type" : "object",
"additionalProperties" : {
"type" : "string",
"description" : "List of potential matches found during fraud check."
},
"description" : "List of potential matches found during fraud check."
}
}
},
"description" : "List of details on the fraud check performed."
},
"FraudCheckResult" : {
"type" : "object",
"properties" : {
"fraudCheck" : {
"$ref" : "#/components/schemas/FraudCheckType"
},
"sourceEvidence" : {
"type" : "array",
"description" : "List of evidences processed during the fraud check.",
"items" : {
"$ref" : "#/components/schemas/FraudAnalyzedEvidence"
}
},
"fraudCheckList" : {
"type" : "array",
"description" : "List of details on the fraud check performed.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckDetails"
}
}
},
"description" : "Contains the result of all fraud checks performed for that identity."
},
"FraudCheckType" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Type of fraud check operation performed",
"example" : "BIOMETRIC_WATCHLIST",
"enum" : [ "AML", "PEP", "INTERPOL", "ACTVITY_HISTORY", "DEATH", "BLACK_LIST", "BIOMETRIC_WATCHLIST", "IDENTITY_WATCHLIST" ]
},
"description" : {
"type" : "string",
"description" : "Details the content of this type of fraud check."
}
},
"description" : "Identifies the type of fraud check performed."
},
"GenderElement" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "Gender value. Values are M (male), F (female), or X (other).",
"example" : "M",
"enum" : [ "M", "F", "X" ]
},
"verified" : {
"type" : "boolean",
"description" : "Describes the verification status of the parent field."
}
},
"description" : "Contains the person's gender. For example : \"{\"value\":\"M\"}\""
},
"GlobalStatusResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"singleStatuses" : {
"type" : "array",
"description" : "Contains a list of evidence statuses.",
"items" : {
"$ref" : "#/components/schemas/SingleStatus"
}
}
}
},
"IdClaim" : {
"required" : [ "claimData", "evidenceId", "submitDateTime", "type" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
},
"claimData" : {
"$ref" : "#/components/schemas/IdClaimData"
}
},
"description" : "Contains details of a processed Id Claim evidence."
},
"IdClaimConf" : {
"type" : "object",
"properties" : {
"issuerPhoneVerificationSupported" : {
"type" : "boolean",
"description" : "Flag defining if issuer phone verification feature is available for this country."
},
"IDClaimSupported" : {
"type" : "boolean",
"description" : "Flag defining if ID Claim verification feature is available for this country."
},
"IDClaimSchema" : {
"type" : "string",
"description" : "Path to the IDClaim schema in OpenAPI service specification."
}
},
"description" : "Describes the rules that apply to the ID Claim verification feature (Experian) for this country."
},
"IdClaimData" : {
"type" : "object",
"properties" : {
"attributesData" : {
"$ref" : "#/components/schemas/AttributesData"
},
"addressesData" : {
"$ref" : "#/components/schemas/AddressData"
},
"contactDetails" : {
"$ref" : "#/components/schemas/ContactDetails"
},
"creditCardDetails" : {
"$ref" : "#/components/schemas/CreditCardDetails"
}
}
},
"IdClaimResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"Claim" : {
"$ref" : "#/components/schemas/IdClaim"
}
}
},
"IdDocument" : {
"required" : [ "evidenceId", "idDocumentData", "submitDateTime", "type" ],
"type" : "object",
"properties" : {
"idDocument" : {
"$ref" : "#/components/schemas/IdDocumentData"
},
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
},
"idDocumentData" : {
"$ref" : "#/components/schemas/IdDocumentData"
}
},
"description" : "Contains a list of submitted identity documents associated with the identity."
},
"IdDocumentData" : {
"required" : [ "expiryDate", "idDocumentNumber", "idDocumentType", "issuingCountry", "personalAttributes" ],
"type" : "object",
"properties" : {
"idDocumentType" : {
"type" : "string",
"description" : "The type of ID document used.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY_CARD", "PASSPORT", "DRIVING_LICENSE", "RESIDENT_CARD", "TAX_CARD", "VOTER_CARD", "ID_DOCUMENT", "VISA", "CERTIFICATE", "ID_CLAIM", "MEDICARE", "WORK_PERMIT" ]
},
"idDocumentNumber" : {
"maxLength" : 20,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9-]*$",
"type" : "string",
"description" : "Document identifier as stated on the document.",
"example" : "1654A354C"
},
"cardNumber" : {
"maxLength" : 50,
"minLength" : 0,
"pattern" : "^[A-Za-z0-9-]*$",
"type" : "string",
"description" : "Card number as stated on the document.",
"example" : "CardNumber"
},
"issuingCountry" : {
"type" : "string",
"description" : "Contains the ISO 3166-1 alpha-3 code referring to the country that issued the document.",
"example" : "USA",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CXR", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESP", "EST", "ETH", "EUE", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBD", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MOZ", "MSR", "MRT", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NER", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "RKS", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SHN", "SLB", "SLE", "SLV", "SMR", "SOM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VNM", "VUT", "WSM", "YEM", "ZAF", "ZMB", "ZWE", "UNK", "UNO", "UNA", "XOM", "XXA", "XXB", "XXC", "XXX", "ALA", "BLM", "ESH", "MAF", "MNP", "NCL", "NFK", "REU", "SGS", "SJM", "SPM", "TKL", "UMI", "VIR", "WLF", "BES", "CUW", "CYM", "GUM", "SXM", "ABR" ]
},
"issuingState" : {
"type" : "string",
"description" : "Name of the state that issued the document.",
"example" : "Washington"
},
"supportDocumentIssuerCountry" : {
"type" : "string",
"description" : "Name of the country that issued the supported document.",
"example" : "FRA",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CXR", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESP", "EST", "ETH", "EUE", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBD", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MOZ", "MSR", "MRT", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NER", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "RKS", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SHN", "SLB", "SLE", "SLV", "SMR", "SOM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VNM", "VUT", "WSM", "YEM", "ZAF", "ZMB", "ZWE", "UNK", "UNO", "UNA", "XOM", "XXA", "XXB", "XXC", "XXX", "ALA", "BLM", "ESH", "MAF", "MNP", "NCL", "NFK", "REU", "SGS", "SJM", "SPM", "TKL", "UMI", "VIR", "WLF", "BES", "CUW", "CYM", "GUM", "SXM", "ABR" ]
},
"issuingAuthority" : {
"maxLength" : 100,
"minLength" : 0,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ -’'‘_\\(\\)]*$",
"type" : "string",
"description" : "Name of the authority that issued the document.",
"example" : "State Police"
},
"issuingDate" : {
"type" : "string",
"description" : "Date on which the document was issued.",
"format" : "date",
"example" : "2018-01-01"
},
"expiryDate" : {
"type" : "string",
"description" : "Date on which the document will expire.",
"format" : "date",
"example" : "2040-01-01"
},
"entryReason" : {
"maxLength" : 100,
"minLength" : 0,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ ”’'‘\\(-_\\)=°+,;:!?.\\/§%$£€#{\\[|\\@\\]}]*$",
"type" : "string",
"description" : "For future use."
},
"personalAttributes" : {
"$ref" : "#/components/schemas/AttributesData"
},
"address" : {
"$ref" : "#/components/schemas/AddressData"
},
"mrz" : {
"maxItems" : 3,
"minItems" : 1,
"type" : "array",
"items" : {
"type" : "string",
"description" : "Contains the document MRZ. Each line is an element of the list.",
"example" : "IDUSADOE<<<<<<<<<<<<<<<<<<<<<<431587"
}
},
"metadata" : {
"maxItems" : 10,
"minItems" : 1,
"type" : "array",
"description" : "May contain additional information depending on use case.",
"items" : {
"$ref" : "#/components/schemas/Metadata"
}
},
"barcode" : {
"type" : "string"
},
"realIdActCompliant" : {
"type" : "boolean",
"description" : "Indicates whether the document is a form of identification that meets the increased security standards for US state-issued driver's licenses and identification cards under the REAL ID Act (U.S. only)"
},
"esfData" : {
"type" : "array",
"description" : "show the esf data returned by the idv and docauth services,these data are exposed as tuple (key,value)",
"items" : {
"$ref" : "#/components/schemas/Metadata"
}
},
"originLanguageIdDocumentData" : {
"$ref" : "#/components/schemas/OriginLanguageIdDocumentData"
}
},
"description" : "Contains all information related to the ID document."
},
"IdDocumentResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"idDocument" : {
"$ref" : "#/components/schemas/IdDocument"
}
}
},
"Identity" : {
"required" : [ "globalStatus" ],
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"context" : {
"type" : "array",
"description" : "Contains a list of context elements.",
"items" : {
"$ref" : "#/components/schemas/ContextElement"
}
},
"consents" : {
"type" : "array",
"description" : "Contains a list submitted consents.",
"items" : {
"$ref" : "#/components/schemas/Consent"
}
},
"attributes" : {
"type" : "array",
"description" : "Contains all identity attribute-related information resulting from the ID proofing process.",
"items" : {
"$ref" : "#/components/schemas/Attributes"
}
},
"contactDetails" : {
"$ref" : "#/components/schemas/ContactDetails"
},
"addresses" : {
"type" : "array",
"description" : "Contains a list of addresses associated with the identity. For future use.",
"items" : {
"$ref" : "#/components/schemas/Address"
}
},
"idDocuments" : {
"type" : "array",
"description" : "Contains a list of submitted identity documents associated with the identity.",
"items" : {
"$ref" : "#/components/schemas/IdDocument"
}
},
"portrait" : {
"$ref" : "#/components/schemas/Portrait"
},
"antifraud" : {
"type" : "array",
"description" : "Contains the result of all fraud checks performed for that identity.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
}
},
"medicares" : {
"type" : "array",
"description" : "Contains a list of medicares associated with the identity.",
"items" : {
"$ref" : "#/components/schemas/Medicare"
}
},
"certificates" : {
"type" : "array",
"description" : "Contains a list of certificates associated with the identity.",
"items" : {
"$ref" : "#/components/schemas/Certificate"
}
},
"trustedIdClaim" : {
"$ref" : "#/components/schemas/TrustedIdClaimEvidence"
},
"portraitReference" : {
"$ref" : "#/components/schemas/PortraitReferenceEvidence"
},
"additionalFiles" : {
"type" : "array",
"description" : "Contains additional information related to the context it is attached to.",
"items" : {
"$ref" : "#/components/schemas/AdditionalFile"
}
},
"partnerAssessment" : {
"$ref" : "#/components/schemas/PartnerAssessmentEvidence"
},
"claimedPortrait" : {
"type" : "array",
"description" : "Contains claimed portrait associated with the identity.",
"items" : {
"$ref" : "#/components/schemas/PortraitReferenceEvidence"
}
}
}
},
"IdentityAddress" : {
"required" : [ "addressesData" ],
"type" : "object",
"properties" : {
"addressesData" : {
"maxItems" : 1,
"minItems" : 1,
"type" : "array",
"description" : "Contains a list of addresses associated with the identity.",
"items" : {
"$ref" : "#/components/schemas/AddressData"
}
}
}
},
"IdentityAttribute" : {
"required" : [ "attributesData" ],
"type" : "object",
"properties" : {
"attributesData" : {
"maxItems" : 1,
"minItems" : 1,
"type" : "array",
"description" : "Contains a list of attributes associated with the identity.",
"items" : {
"$ref" : "#/components/schemas/AttributesDataValidity"
}
},
"score" : {
"maximum" : 5,
"minimum" : 0,
"type" : "integer",
"format" : "int32"
}
}
},
"IdentityStatus" : {
"required" : [ "creationDateTime", "evaluationDateTime", "id", "levelOfAssurance", "status" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "A unique identifier assigned to the identity.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"correlation-id" : {
"type" : "string",
"description" : "Unique identifier generated by the client application.",
"example" : "7c622957-bc54-4031"
},
"status" : {
"type" : "string",
"description" : "Overall status of the identity.",
"example" : "EXPECTING_INPUT",
"enum" : [ "EXPECTING_INPUT", "PROCESSING", "DONE", "TIMEOUT", "PAUSED" ]
},
"levelOfAssurance" : {
"type" : "string",
"description" : "Overall Level Of Assurance reached by the identity after proofing.",
"example" : "LOA1",
"enum" : [ "LOA0", "LOA1", "LOA2", "LOA3", "LOA4", "LOA5", "LOA6" ]
},
"creationDateTime" : {
"type" : "string",
"description" : "Date of creation of the identity.",
"format" : "date-time"
},
"evaluationDateTime" : {
"type" : "string",
"description" : "Date on which the identity was last evaluated.",
"format" : "date-time"
},
"revalidationDate" : {
"type" : "string",
"description" : "Date on which the identity will need to be revalidated.",
"example" : "2018-01-01"
},
"nameReferenceEvidenceId" : {
"type" : "string",
"description" : "ID of the reference evidence used as an authoritative source for that identity.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"portraitReferenceEvidenceId" : {
"type" : "string",
"description" : "ID of the evidence used as a reference for portrait verification.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"expireAt" : {
"type" : "string",
"description" : "Expiration date of the transaction after this time the transaction will be deleted",
"format" : "date-time"
},
"upgradePaths" : {
"type" : "object",
"properties" : {
"LOA1" : {
"type" : "object",
"properties" : {
"ATTRIBUTES" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "LEVEL1"
}
}
}
}
},
"LOA2" : {
"type" : "object",
"properties" : {
"ID_DOCUMENTS" : {
"type" : "array",
"items" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "LEVEL1"
}
}
}
}
}
},
"description" : "List all possibilities for the user to improve its level of assurance"
}
},
"description" : "Contains status of the associated response element."
},
"Indicator" : {
"type" : "object",
"properties" : {
"controlName" : {
"type" : "string",
"enum" : [ "ABNORMAL_DOCUMENT_FEATURES_CHECK", "AUTHORIZED_DOCUMENT_TYPE", "BIRTHDATE_VALID", "BLUR_IMAGE_QUALITY", "BLUR_IMAGE_QUALITY_BACK", "BLUR_IMAGE_QUALITY_FRONT", "CAPTURE_TAMPERING", "CAPTURE_TOO_CLOSE_CHECK", "CAPTURE_TOO_FAR_CHECK", "CB2D_FIELDS_SYNTAX", "COMPROMISED_DOCUMENT_CHECK", "CORNER_REMOVED_CHECK", "COVERED_IMAGE_CHECK", "CUT_OFF_DOCUMENT_CHECK", "DAMAGED_DOCUMENT_CHECK", "DARK_IMAGE_QUALITY", "DATA_GROUP1_CHECK", "DOC_EXPIRATION_DATE", "DOC_ISSUING_COUNTRY", "DOC_NATIONALITY", "DOC_TYPE", "DOCUMENT_BACKGROUND_CHECK", "DOCUMENT_BARCODE_PARSING", "DOCUMENT_CLASS_COMPARE", "DOCUMENT_ISSUER_WHITE_LIST", "DOCUMENT_LOST_STOLEN_CHECK", "DOCUMENT_NUMBER_VALIDITY", "DOCUMENT_VELOCITY_CHECK", "ESF", "ESFX", "FONTS_CHECK", "GENDER_VALIDITY", "GLARE_IMAGE_QUALITY", "GLARE_IMAGE_QUALITY_BACK", "GLARE_IMAGE_QUALITY_FRONT", "GOV_DATA_FORMAT", "HIGH_TEMPLATE", "IDQR", "IDQRX", "IMAGE_BACK_DPI_CHECK", "IMAGE_FRONT_DPI_CHECK", "IMAGE_WITHOUT_DOCUMENT_CHECK", "ISSUANCE_DATE_VALIDITY", "KEYSTONE_IMAGE_QUALITY", "KEYSTONE_IMAGE_QUALITY_BACK", "KEYSTONE_IMAGE_QUALITY_FRONT", "KNOWN_FRAUDULENT_DOCUMENT_CHECK", "LCD_DETECTION", "LINECODE", "LINECODEX", "LOW_IMAGE_QUALITY_BACK", "LOW_IMAGE_QUALITY_FRONT", "LOW_TEMPLATE", "MODEL_COLOR_MATCHING", "MODEL_CONSISTENCY_CHECK", "MODEL_RECOGNIZED", "MRZ_BARCODE_CROSSCHECK", "MRZ_CHECKSUMS", "MRZ_FIELDS_SYNTAX", "MRZ_PRESENCE", "NO_MULTIPLE_DOCUMENT_CHECK", "OBSCURED_DATA_CHECK", "OBSCURED_SECURITY_FEATURES_CHECK", "OCR_BIRTHDATE", "OCR_DOC_NATIONALITY", "OCR_DOCNUM", "OCR_EXPIRATION_DATE", "OCR_FIRSTNAMES", "OCR_ISSUING_COUNTRY", "OCR_LASTNAME", "OCR_PERSONAL_NUMBER", "OCR_SEX", "OCRX", "OTHER_QUALITY_CHECK", "OTHER_SUSPICIOUS_ELEMENT", "PERSONAL_NUMBER_CHECKSUMS", "PHOTO_LOCATION", "PHOTOCOPY_DETECTION", "PORTRAIT", "PUNCTURED_DOCUMENT_CHECK", "REAL_ID_COMPLIANT", "REQUIRED_SIDES_CHECK", "REVOKED_PRIVILEGE_CHECK", "SCREENSHOT_DETECTION", "SIDES_MODEL_CONSISTENCY", "SUSPENDED_PRIVILEGE_CHECK", "TEXTURE_ANALYSIS", "VISUAL_SECURITY", "BIOMETRIC_HYPER_MATCHING", "BIOMETRIC_LIVENESS_ASSERTION", "BIOMETRIC_LIVENESS_CHALLENGE", "BIOMETRIC_MATCHING_CHECK", "BIOMETRIC_QUALITY_CHECK", "GESTURE_ASSESSMENT", "LIVENESS_ASSESSMENT", "ADDRESS_CITY_COMPARE", "ADDRESS_COUNTRY_COMPARE", "ADDRESS_DISTRICT_COMPARE", "ADDRESS_HOUSE_NUMBER_COMPARE", "ADDRESS_POSTCODE_COMPARE", "ADDRESS_STATE_COMPARE", "ADDRESS_STREET_COMPARE", "AGE_COMPARE", "AUTHORITY_COMPARE", "BIRTHDATE_COMPARE", "BLOOD_GROUP_COMPARE", "DOC_ACTIVE", "DOCUMENT_TYPE_COMPARE", "DONOR_COMPARE", "EYECOLOR_COMPARE", "EXPIRYDATE_COMPARE", "FIRSTNAME_COMPARE", "FIRSTNAME_FUZZY_COMPARE", "FULLADDRESS_COMPARE", "FULLNAME_COMPARE", "GENDER_COMPARE", "GIV_AVAILABILITY", "GIV_ELIGIBILITY", "GIV_IDENTITY_FOUND", "GIV_VERIFICATION", "GIVENNAME_COMPARE", "HAIR_COLOR_COMPARE", "HEIGHT_COMPARE", "IDDOCUMENT_NUMBER_COMPARE", "ISSUING_COUNTRY_COMPARE", "ISSUING_STATE_COMPARE", "ISSUINGDATE_COMPARE", "MIDDLENAME_COMPARE", "MIDDLENAME_FUZZY_COMPARE", "MIDDLENAME_INITIAL_COMPARE", "MSISDN_COMPARE", "NAMESUFFIX_COMPARE", "PERSONAL_NUMBER_COMPARE", "POLLING_STATION_COMPARE", "RELATIVE_FULLNAME_COMPARE", "RELATIVE_TYPE_COMPARE", "RESTRICTIONS_COMPARE", "SURNAME_COMPARE", "SURNAME_FUZZY_COMPARE", "TITLE_COMPARE", "USAGENAME_COMPARE", "VETERAN_COMPARE", "WEIGHT_COMPARE", "ACCOUNT_ACTIVE", "ACCOUNT_IS_DISCONNECTED", "ACCOUNT_IS_PRIMARY", "ACCOUNT_PERSONAL", "ACCOUNT_PORT_RECENCY", "ACCOUNT_RECENCY", "ACCOUNT_TENURE", "ACCOUNT_TYPE", "ADDRESS_COMPARE", "ADDRESS_FUZZY_COMPARE", "ATTRIBUTES_DOB_MULTIPLE", "ATTRIBUTES_SSN_COMPARE", "ATTRIBUTES_SSN_ISSUANCE", "ATTRIBUTES_SSN_MULTIPLE", "ATTRIBUTES_SSN_VALIDITY", "ATTRIBUTES_SWITCH_FIRST_LAST", "ATTRIBUTES_VALIDITY", "CLAIM_VERIFICATION", "CREDIT_CARD_CLOSED_CHECK", "CREDIT_CARD_COMPARE", "CREDIT_CARD_LOST_STOLEN_CHECK", "EMAILADRRESS_COMPARE", "FULLADDRESS_FUZZY_COMPARE", "FULLNAME_FUZZY_COMPARE", "HOLDER_AGE", "IDENTITY_COMPARE", "IDENTITY_FOUND", "LINETYPE_CHECK", "NAME_CONSISTENCY_CHECK", "REUSED_MSISDN_CHECK", "USER_DECEASED_CHECK", "USER_SUSPENDED", "ADDRESS_CONSISTENCY_CHECK", "ADDRESS_INCONSISTENCY", "ADDRESS_MOVED", "ADDRESS_PERSONAL_BOX", "ADDRESS_VALIDITY", "COMPUTER_SCREEN_PHOTO", "DOCUMENT_ADJUDICATION", "DOCUMENT_IMAGE_MANIPULATION", "DOCUMENT_TEMPLATE_DIFFERENT_FROM_REFERENCE", "INCONSISTENT_FONT_SIZE_OR_TYPE", "OTHER_SUSPECTED_FRAUD", "PAPER_COPY", "PORTRAIT_SUBSTITUTION", "VIDEO_ADJUDICATION", "ACTIVE_AUTHENTICATION_CHECK", "BASIC_ACCESS_CONTROL_CHECK", "CHIP_AUTHENTICATION_CHECK", "PASOD_SIGNATURE_CHECK", "PASSIVE_AUTHENTICATION_CHECK", "PASSIVE_AUTHENTICATION_DOCUMENT_SIGNER_CHECK", "PASSIVE_AUTHENTICATION_HASH_CHECK", "PASSWORD_AUTHENTICATED_CONNECTION_ESTABLISHMENT_CHECK", "TERMINAL_AUTHENTICATION_CHECK", "OIDC_AUTHENTICATION", "ADDRESS_FUZZY", "AML_CHECK", "ATTRIBUTES_DOB_FUZZY", "ATTRIBUTES_FRAUD_LIST", "ATTRIBUTES_GIVEN_NAMES_FUZZY", "ATTRIBUTES_MULTIPLE_MATCH", "ATTRIBUTES_OFAC_LIST", "ATTRIBUTES_PEP_LIST", "ATTRIBUTES_SANCTION_LIST", "ATTRIBUTES_SSN_FOREIGN", "ATTRIBUTES_SSN_FUZZY", "ATTRIBUTES_SSN_RECENCY", "ATTRIBUTES_SURNAME_FUZZY", "ATTRIBUTES_VELOCITY", "AUTHORIZED_ISSUING_COUNTRY", "BANKRUPTCY_AND_INSOLVENCY", "DOCUMENT_VELOCITY_CHECK_STEPUP", "DOCUMENT_VELOCITY_CHECK_IN_PERSON_REVIEW", "DOCUMENT_VELOCITY_CHECK_MANUAL_REVIEW", "EMISSION_COUNTRY", "EMISSION_DATE", "PARTNER_ASSESSMENT", "PEP_CHECK", "RED_NOTICE_CHECK" ]
},
"indicatorStatus" : {
"type" : "string",
"enum" : [ "OK", "WARNING", "UNVERIFIED", "FAILED" ]
},
"name" : {
"type" : "string",
"writeOnly" : true,
"enum" : [ "ABNORMAL_DOCUMENT_FEATURES_CHECK", "AUTHORIZED_DOCUMENT_TYPE", "BIRTHDATE_VALID", "BLUR_IMAGE_QUALITY", "BLUR_IMAGE_QUALITY_BACK", "BLUR_IMAGE_QUALITY_FRONT", "CAPTURE_TAMPERING", "CAPTURE_TOO_CLOSE_CHECK", "CAPTURE_TOO_FAR_CHECK", "CB2D_FIELDS_SYNTAX", "COMPROMISED_DOCUMENT_CHECK", "CORNER_REMOVED_CHECK", "COVERED_IMAGE_CHECK", "CUT_OFF_DOCUMENT_CHECK", "DAMAGED_DOCUMENT_CHECK", "DARK_IMAGE_QUALITY", "DATA_GROUP1_CHECK", "DOC_EXPIRATION_DATE", "DOC_ISSUING_COUNTRY", "DOC_NATIONALITY", "DOC_TYPE", "DOCUMENT_BACKGROUND_CHECK", "DOCUMENT_BARCODE_PARSING", "DOCUMENT_CLASS_COMPARE", "DOCUMENT_ISSUER_WHITE_LIST", "DOCUMENT_LOST_STOLEN_CHECK", "DOCUMENT_NUMBER_VALIDITY", "DOCUMENT_VELOCITY_CHECK", "ESF", "ESFX", "FONTS_CHECK", "GENDER_VALIDITY", "GLARE_IMAGE_QUALITY", "GLARE_IMAGE_QUALITY_BACK", "GLARE_IMAGE_QUALITY_FRONT", "GOV_DATA_FORMAT", "HIGH_TEMPLATE", "IDQR", "IDQRX", "IMAGE_BACK_DPI_CHECK", "IMAGE_FRONT_DPI_CHECK", "IMAGE_WITHOUT_DOCUMENT_CHECK", "ISSUANCE_DATE_VALIDITY", "KEYSTONE_IMAGE_QUALITY", "KEYSTONE_IMAGE_QUALITY_BACK", "KEYSTONE_IMAGE_QUALITY_FRONT", "KNOWN_FRAUDULENT_DOCUMENT_CHECK", "LCD_DETECTION", "LINECODE", "LINECODEX", "LOW_IMAGE_QUALITY_BACK", "LOW_IMAGE_QUALITY_FRONT", "LOW_TEMPLATE", "MODEL_COLOR_MATCHING", "MODEL_CONSISTENCY_CHECK", "MODEL_RECOGNIZED", "MRZ_BARCODE_CROSSCHECK", "MRZ_CHECKSUMS", "MRZ_FIELDS_SYNTAX", "MRZ_PRESENCE", "NO_MULTIPLE_DOCUMENT_CHECK", "OBSCURED_DATA_CHECK", "OBSCURED_SECURITY_FEATURES_CHECK", "OCR_BIRTHDATE", "OCR_DOC_NATIONALITY", "OCR_DOCNUM", "OCR_EXPIRATION_DATE", "OCR_FIRSTNAMES", "OCR_ISSUING_COUNTRY", "OCR_LASTNAME", "OCR_PERSONAL_NUMBER", "OCR_SEX", "OCRX", "OTHER_QUALITY_CHECK", "OTHER_SUSPICIOUS_ELEMENT", "PERSONAL_NUMBER_CHECKSUMS", "PHOTO_LOCATION", "PHOTOCOPY_DETECTION", "PORTRAIT", "PUNCTURED_DOCUMENT_CHECK", "REAL_ID_COMPLIANT", "REQUIRED_SIDES_CHECK", "REVOKED_PRIVILEGE_CHECK", "SCREENSHOT_DETECTION", "SIDES_MODEL_CONSISTENCY", "SUSPENDED_PRIVILEGE_CHECK", "TEXTURE_ANALYSIS", "VISUAL_SECURITY", "BIOMETRIC_HYPER_MATCHING", "BIOMETRIC_LIVENESS_ASSERTION", "BIOMETRIC_LIVENESS_CHALLENGE", "BIOMETRIC_MATCHING_CHECK", "BIOMETRIC_QUALITY_CHECK", "GESTURE_ASSESSMENT", "LIVENESS_ASSESSMENT", "ADDRESS_CITY_COMPARE", "ADDRESS_COUNTRY_COMPARE", "ADDRESS_DISTRICT_COMPARE", "ADDRESS_HOUSE_NUMBER_COMPARE", "ADDRESS_POSTCODE_COMPARE", "ADDRESS_STATE_COMPARE", "ADDRESS_STREET_COMPARE", "AGE_COMPARE", "AUTHORITY_COMPARE", "BIRTHDATE_COMPARE", "BLOOD_GROUP_COMPARE", "DOC_ACTIVE", "DOCUMENT_TYPE_COMPARE", "DONOR_COMPARE", "EYECOLOR_COMPARE", "EXPIRYDATE_COMPARE", "FIRSTNAME_COMPARE", "FIRSTNAME_FUZZY_COMPARE", "FULLADDRESS_COMPARE", "FULLNAME_COMPARE", "GENDER_COMPARE", "GIV_AVAILABILITY", "GIV_ELIGIBILITY", "GIV_IDENTITY_FOUND", "GIV_VERIFICATION", "GIVENNAME_COMPARE", "HAIR_COLOR_COMPARE", "HEIGHT_COMPARE", "IDDOCUMENT_NUMBER_COMPARE", "ISSUING_COUNTRY_COMPARE", "ISSUING_STATE_COMPARE", "ISSUINGDATE_COMPARE", "MIDDLENAME_COMPARE", "MIDDLENAME_FUZZY_COMPARE", "MIDDLENAME_INITIAL_COMPARE", "MSISDN_COMPARE", "NAMESUFFIX_COMPARE", "PERSONAL_NUMBER_COMPARE", "POLLING_STATION_COMPARE", "RELATIVE_FULLNAME_COMPARE", "RELATIVE_TYPE_COMPARE", "RESTRICTIONS_COMPARE", "SURNAME_COMPARE", "SURNAME_FUZZY_COMPARE", "TITLE_COMPARE", "USAGENAME_COMPARE", "VETERAN_COMPARE", "WEIGHT_COMPARE", "ACCOUNT_ACTIVE", "ACCOUNT_IS_DISCONNECTED", "ACCOUNT_IS_PRIMARY", "ACCOUNT_PERSONAL", "ACCOUNT_PORT_RECENCY", "ACCOUNT_RECENCY", "ACCOUNT_TENURE", "ACCOUNT_TYPE", "ADDRESS_COMPARE", "ADDRESS_FUZZY_COMPARE", "ATTRIBUTES_DOB_MULTIPLE", "ATTRIBUTES_SSN_COMPARE", "ATTRIBUTES_SSN_ISSUANCE", "ATTRIBUTES_SSN_MULTIPLE", "ATTRIBUTES_SSN_VALIDITY", "ATTRIBUTES_SWITCH_FIRST_LAST", "ATTRIBUTES_VALIDITY", "CLAIM_VERIFICATION", "CREDIT_CARD_CLOSED_CHECK", "CREDIT_CARD_COMPARE", "CREDIT_CARD_LOST_STOLEN_CHECK", "EMAILADRRESS_COMPARE", "FULLADDRESS_FUZZY_COMPARE", "FULLNAME_FUZZY_COMPARE", "HOLDER_AGE", "IDENTITY_COMPARE", "IDENTITY_FOUND", "LINETYPE_CHECK", "NAME_CONSISTENCY_CHECK", "REUSED_MSISDN_CHECK", "USER_DECEASED_CHECK", "USER_SUSPENDED", "ADDRESS_CONSISTENCY_CHECK", "ADDRESS_INCONSISTENCY", "ADDRESS_MOVED", "ADDRESS_PERSONAL_BOX", "ADDRESS_VALIDITY", "COMPUTER_SCREEN_PHOTO", "DOCUMENT_ADJUDICATION", "DOCUMENT_IMAGE_MANIPULATION", "DOCUMENT_TEMPLATE_DIFFERENT_FROM_REFERENCE", "INCONSISTENT_FONT_SIZE_OR_TYPE", "OTHER_SUSPECTED_FRAUD", "PAPER_COPY", "PORTRAIT_SUBSTITUTION", "VIDEO_ADJUDICATION", "ACTIVE_AUTHENTICATION_CHECK", "BASIC_ACCESS_CONTROL_CHECK", "CHIP_AUTHENTICATION_CHECK", "PASOD_SIGNATURE_CHECK", "PASSIVE_AUTHENTICATION_CHECK", "PASSIVE_AUTHENTICATION_DOCUMENT_SIGNER_CHECK", "PASSIVE_AUTHENTICATION_HASH_CHECK", "PASSWORD_AUTHENTICATED_CONNECTION_ESTABLISHMENT_CHECK", "TERMINAL_AUTHENTICATION_CHECK", "OIDC_AUTHENTICATION", "ADDRESS_FUZZY", "AML_CHECK", "ATTRIBUTES_DOB_FUZZY", "ATTRIBUTES_FRAUD_LIST", "ATTRIBUTES_GIVEN_NAMES_FUZZY", "ATTRIBUTES_MULTIPLE_MATCH", "ATTRIBUTES_OFAC_LIST", "ATTRIBUTES_PEP_LIST", "ATTRIBUTES_SANCTION_LIST", "ATTRIBUTES_SSN_FOREIGN", "ATTRIBUTES_SSN_FUZZY", "ATTRIBUTES_SSN_RECENCY", "ATTRIBUTES_SURNAME_FUZZY", "ATTRIBUTES_VELOCITY", "AUTHORIZED_ISSUING_COUNTRY", "BANKRUPTCY_AND_INSOLVENCY", "DOCUMENT_VELOCITY_CHECK_STEPUP", "DOCUMENT_VELOCITY_CHECK_IN_PERSON_REVIEW", "DOCUMENT_VELOCITY_CHECK_MANUAL_REVIEW", "EMISSION_COUNTRY", "EMISSION_DATE", "PARTNER_ASSESSMENT", "PEP_CHECK", "RED_NOTICE_CHECK" ]
},
"indicatorName" : {
"type" : "string"
},
"contraIndicatorElementType" : {
"type" : "string",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"description" : {
"type" : "string"
}
}
},
"InitLivenessParameters" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Liveness type. \n
Note: LIVENESS_HIGH is deprecated and replaced by LIVENESS_ACTIVE",
"example" : "LIVENESS_ACTIVE",
"enum" : [ "LIVENESS_ACTIVE", "LIVENESS_MLC", "LIVENESS_PASSIVE", "LIVENESS_PASSIVE_VIDEO", "LIVENESS_HIGH" ]
},
"securityLevel" : {
"type" : "string",
"description" : "Specify the level of security. Higher level makes a smaller target. \n
Note: If the field is provided, it will be ignored by the service",
"example" : "HIGH",
"deprecated" : true,
"enum" : [ "LOW, MEDIUM, HIGH" ]
},
"nbChallenge" : {
"pattern" : "[0-5]",
"type" : "string",
"description" : "Number of challenge to ask, at least one",
"example" : "2",
"deprecated" : true
}
}
},
"InputPart" : {
"type" : "object",
"properties" : {
"bodyAsString" : {
"type" : "string"
},
"contentTypeFromMessage" : {
"type" : "boolean"
},
"mediaType" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"subtype" : {
"type" : "string"
},
"parameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"wildcardType" : {
"type" : "boolean"
},
"wildcardSubtype" : {
"type" : "boolean"
}
}
},
"headers" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
},
"LiveCaptureSession" : {
"type" : "object",
"properties" : {
"issuingCountry" : {
"type" : "string",
"description" : "Issuing country used for live capture session creation",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CXR", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESP", "EST", "ETH", "EUE", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBD", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MOZ", "MSR", "MRT", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NER", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "RKS", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SHN", "SLB", "SLE", "SLV", "SMR", "SOM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VNM", "VUT", "WSM", "YEM", "ZAF", "ZMB", "ZWE", "UNK", "UNO", "UNA", "XOM", "XXA", "XXB", "XXC", "XXX", "ALA", "BLM", "ESH", "MAF", "MNP", "NCL", "NFK", "REU", "SGS", "SJM", "SPM", "TKL", "UMI", "VIR", "WLF", "BES", "CUW", "CYM", "GUM", "SXM", "ABR" ]
},
"idDocumentType" : {
"type" : "string",
"description" : "Document type used for live capture session creation",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"sidesToCapture" : {
"type" : "array",
"description" : "List of side that will be captured. If the Document type is missing, this list will be ignored.",
"items" : {
"type" : "string",
"description" : "List of side that will be captured. If the Document type is missing, this list will be ignored.",
"enum" : [ "FRONT", "BACK" ]
}
}
}
},
"LiveCaptureStatus" : {
"required" : [ "status" ],
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "The value of the status.",
"example" : "PROCESSING",
"enum" : [ "VERIFIED", "NOT_VERIFIED", "PROCESSING", "ADJUDICATION", "INVALID" ]
},
"type" : {
"type" : "string",
"description" : "The type of element the status is expressed for.",
"example" : "ID_DOCUMENT",
"default" : "ID_DOCUMENT"
},
"id" : {
"type" : "string",
"description" : "ID used to identify the status.",
"example" : "gips-998cf41c-6d76-45d2-b173-185854dc959f"
},
"errors" : {
"type" : "array",
"description" : "The list of errors associated with the status.",
"items" : {
"$ref" : "#/components/schemas/Error"
}
},
"sessionId" : {
"type" : "string",
"description" : "Unique identifier of the WEB-DOC session"
},
"sidesToCapture" : {
"type" : "array",
"description" : "List of side that will be captured",
"items" : {
"type" : "string",
"description" : "List of side that will be captured",
"enum" : [ "FRONT", "BACK" ]
}
}
}
},
"LivenessParameters" : {
"required" : [ "certificates", "nbChallenge", "securityLevel", "seed", "serverRandom", "signature", "timeout", "type" ],
"type" : "object",
"properties" : {
"seed" : {
"type" : "string",
"description" : "Seed generated by WebioServer used to run the challenge"
},
"serverRandom" : {
"type" : "string",
"description" : "Random 32 bytes string generated by WebioServer used to check the encryptedMetaData"
},
"certificates" : {
"type" : "array",
"description" : "List of Base64 encoded certificates in DER format. To be used to encrypt metadata",
"items" : {
"type" : "string",
"description" : "List of Base64 encoded certificates in DER format. To be used to encrypt metadata"
}
},
"type" : {
"type" : "string",
"description" : "Liveness type",
"enum" : [ "LIVENESS_HIGH", "HIGH", "LIVENESS_PASSIVE", "PASSIVE", "LIVENESS_PASSIVE_VIDEO", "LIVENESS_ACTIVE", "LIVENESS_MLC" ]
},
"timeout" : {
"type" : "integer",
"description" : "Timeout before end of acquisition (in ms / 0 is infinite)",
"format" : "int32"
},
"securityLevel" : {
"type" : "string",
"description" : "Specify the level of security. Higher level makes a smaller target",
"enum" : [ "VERY_LOW", "LOW", "MEDIUM", "HIGH", "VERY_HIGH", "VERY_HIGH2", "VERY_HIGH3", "VERY_HIGH4", "VERY_HIGH5", "LOW, MEDIUM, HIGH, VERY_HIGH, VERY_HIGH2, VERY_HIGH3, VERY_HIGH4, VERY_HIGH5" ]
},
"nbChallenge" : {
"type" : "integer",
"description" : "Number of challenge to ask, at least one",
"format" : "int32",
"example" : 2,
"deprecated" : true
},
"useAccurateMatch" : {
"type" : "boolean",
"description" : "If true then WebioServer matching algo will be applied on the given liveness metadata images",
"deprecated" : true
},
"matchThreshold" : {
"type" : "integer",
"description" : "The matching threshold used when matching the liveness metadata images",
"format" : "int32",
"deprecated" : true
},
"signature" : {
"type" : "string",
"description" : "A digital signature (JWS) of the response. Authentication and integrity can be verified afterward using the BioServer public certificate"
}
},
"description" : "Contains parameters used for liveness challenge."
},
"LivenessSingleStatus" : {
"required" : [ "status" ],
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "The value of the status.",
"example" : "PROCESSING",
"enum" : [ "VERIFIED", "NOT_VERIFIED", "PROCESSING", "ADJUDICATION", "INVALID" ]
},
"type" : {
"type" : "string",
"description" : "The type of element the status is expressed for.",
"example" : "ID_DOCUMENT",
"default" : "ID_DOCUMENT"
},
"id" : {
"type" : "string",
"description" : "ID used to identify the status.",
"example" : "gips-998cf41c-6d76-45d2-b173-185854dc959f"
},
"errors" : {
"type" : "array",
"description" : "The list of errors associated with the status.",
"items" : {
"$ref" : "#/components/schemas/Error"
}
},
"sessionId" : {
"type" : "string",
"description" : "Unique identifier of the bioserver session"
},
"livenessParameters" : {
"$ref" : "#/components/schemas/LivenessParameters"
}
}
},
"Medicare" : {
"required" : [ "evidenceId", "submitDateTime", "type" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
},
"medicareData" : {
"$ref" : "#/components/schemas/MedicareData"
}
},
"description" : "Contains details of a processed medicare evidence."
},
"MedicareData" : {
"required" : [ "cardNumber", "cardType", "expiryDate", "individualReferenceNumber" ],
"type" : "object",
"properties" : {
"cardNumber" : {
"maxLength" : 10,
"minLength" : 10,
"pattern" : "^[A-Za-z0-9-]*$",
"type" : "string",
"description" : "Contains the card identifier as stated on the document.",
"example" : "2951635672"
},
"cardType" : {
"type" : "string",
"description" : "Contains the model/type of the medicare card.",
"example" : "Y"
},
"issuingCountry" : {
"type" : "string",
"description" : "Contains the 3 letter country code defined by ISO 3166-1 referring to the country issuing the medicare card",
"example" : "AUS",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CXR", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESP", "EST", "ETH", "EUE", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBD", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MOZ", "MSR", "MRT", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NER", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "RKS", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SHN", "SLB", "SLE", "SLV", "SMR", "SOM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VNM", "VUT", "WSM", "YEM", "ZAF", "ZMB", "ZWE", "UNK", "UNO", "UNA", "XOM", "XXA", "XXB", "XXC", "XXX", "ALA", "BLM", "ESH", "MAF", "MNP", "NCL", "NFK", "REU", "SGS", "SJM", "SPM", "TKL", "UMI", "VIR", "WLF", "BES", "CUW", "CYM", "GUM", "SXM", "ABR" ]
},
"expiryDate" : {
"type" : "string",
"description" : "Date on which the medicare expires.",
"example" : "2050-01-01"
},
"fullname2" : {
"maxLength" : 25,
"minLength" : 1,
"type" : "string",
"description" : "Contains the person's full name2."
},
"fullname3" : {
"maxLength" : 23,
"minLength" : 1,
"type" : "string",
"description" : "Contains the person's full name3."
},
"fullname4" : {
"maxLength" : 21,
"minLength" : 1,
"type" : "string",
"description" : "Contains the person's full name4."
},
"individualReferenceNumber" : {
"type" : "integer",
"description" : "The medicare individual reference number",
"format" : "int32",
"example" : 1
},
"personalAttributes" : {
"$ref" : "#/components/schemas/AttributesData"
}
}
},
"MedicareResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"medicare" : {
"$ref" : "#/components/schemas/Medicare"
}
}
},
"Metadata" : {
"required" : [ "key", "value" ],
"type" : "object",
"properties" : {
"key" : {
"maxLength" : 50,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9_]*$",
"type" : "string",
"description" : "key",
"example" : "IRN"
},
"value" : {
"maxLength" : 1024,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9 @.\\-_’']*$",
"type" : "string",
"description" : "value",
"example" : "1"
}
},
"description" : "May contain additional information depending on use case."
},
"MobileElement" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"value" : {
"maxLength" : 20,
"minLength" : 2,
"pattern" : "^\\+[1-9]\\d{1,14}$",
"type" : "string",
"description" : "The phone number to verify. Phone numbers must be in E.164 format."
}
},
"description" : "Mobile phone number that can be used to contact the user. For example : +14999999999"
},
"Mrz" : {
"required" : [ "mrz" ],
"type" : "object",
"properties" : {
"mrz" : {
"maxItems" : 3,
"minItems" : 1,
"type" : "array",
"items" : {
"type" : "string",
"description" : "Contains the document MRZ. Each line is an element of the list.",
"example" : "IDUSADOE<<<<<<<<<<<<<<<<<<<<<<431587"
}
}
},
"description" : "Mrz, each mrz lines is an array item"
},
"MultipartAdditionalFiles" : {
"required" : [ "File", "Metadata" ],
"type" : "object",
"properties" : {
"File" : {
"type" : "string",
"description" : "The additional file to upload to the identity.
Maximum file size : 2Mbytes.
Maximum number of files : 5",
"format" : "binary"
},
"Metadata" : {
"type" : "string",
"description" : "Contains additional information related to the context it is attached to.
Metadata payload is json file containing an array of key/value pairs.
It must contain at least one key named \"TYPE\"
The maximum number of key/value pairs is 10.
Key maximum length is 50 characters and key Regex pattern is ^[A-Za-z0-9_]*
Value maximum length is 1024 characters and value regex pattern is ^[A-Za-z0-9 @.\\\\-_’']*
For example:
{
\"metadata\" : [
{
\"key\": \"NAME\",
\"value\": \"file.jpg\"
},
{
\"key\": \"TYPE\",
\"value\": \"image\"
}
]
}",
"format" : "json"
}
}
},
"MultipartCreateIdentity" : {
"type" : "object",
"properties" : {
"context" : {
"type" : "string",
"description" : "The key field is limited to 50 uppercase alphabetic (no diacritics) or numeric characters, plus the underscore. The value is limited to 1024 alphabetic (including diacritics) or numeric characters, plus the underscore, space, hyphen, arobase, plus, dot, parentheses, slash and antislash, single and double quotes, and brackets.\n
Example of context file :\n[{\n\t\"key\": \"PID\",\n\t\"value\": \"987654321-0\"\n},\n{\n\t\"key\": \"APPLICATION\",\n\t\"value\": \"User_Onboarding\"\n},\n{\n\t\"key\": \"BUSINESS_ID\",\n\t\"value\": \"eb18d509-b99b-4b35-a6e3-7c0f4e2a6fb7\"\n},\n{\n\t\"key\": \"CHANNEL\",\n\t\"value\": \"Web\"\n}]",
"format" : "binary"
}
}
},
"MultipartDocumentCapture" : {
"required" : [ "DocumentFront" ],
"type" : "object",
"properties" : {
"DocumentFront" : {
"type" : "string",
"description" : "The document front image. JPG, PNG or PDF, max 5 MB.",
"format" : "binary"
},
"DocumentBack" : {
"type" : "string",
"description" : "The document back image. Back image capture may be mandatory for some documents. JPG, PNG or PDF, max 5 MB.",
"format" : "binary"
},
"DocumentCaptureDetails" : {
"type" : "string",
"description" : "A JSON object containing the issuing jurisdiction of the evidence the document type (PASSPORT, DRIVING_LICENSE, RESIDENT_CARD, IDENTITY_CARD, TAX_CARD, VOTER_CARD, WORK_PERMIT), the source of the image (LIVE_CAPTURE_IMAGE if the identity document image was taken live with Doc SDK at the time of the transaction, LIVE_CAPTURE_VIDEO if the identity document image was extracted during a Web RTC session or a video chat for example, SCAN if the photo of the identity document is a scan, or OTHER for other source). The MRZ or the barcode (PDF417 format) of the identity document (as extracted by the SDK, if available). The JSON object can also contain a list of metadata (keys and values) that will not impact evaluation (you can set for example the device type). The fields frondCaptureCropped and backCaptureCropped indicates respectively whether the front or back of the document picture has already been cropped to remove the picture background. For example:
{
\"jurisdiction\": \"USA\",
\"documentType\": \"DRIVING_LICENSE\",
\"source\": \"LIVE_CAPTURE_IMAGE\",
\"frontCaptureCropped\" : true,
\"backCaptureCropped\" : true,
\"metadata\": [{
\"\"key\": \"DEVICE\",
\"value\": \"IPHONE\"
}]
}",
"format" : "binary"
}
}
},
"MultipartFormDataInput" : {
"type" : "object",
"properties" : {
"formData" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/InputPart"
}
},
"formDataMap" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/InputPart"
}
}
},
"preamble" : {
"type" : "string"
},
"parts" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/InputPart"
}
}
}
},
"MultipartPortrait" : {
"required" : [ "Portrait" ],
"type" : "object",
"properties" : {
"Portrait" : {
"type" : "string",
"description" : "The portrait image. JPG or PNG, max 2MB. Usually 100kb is sufficient.",
"format" : "binary"
},
"PortraitInformation" : {
"type" : "string",
"description" : "Source of the portrait image: LIVE_CAPTURE_IMAGE if the portrait image is a static picture captured by the SmartBio SDK after liveness check, LIVE_CAPTURE_VIDEO if the portrait image was extracted\\ during a Web RTC session or a video chat for example, SCAN if the portrait is an uploaded scan of a photograph, DOCUMENT_CROP if the portrait is sourced from a document crop, or OTHER for other source. The JSON object can also contain a list of metadata (keys and values) that will not impact evaluation (e.g., the device type). For example:
{
\"source\": \"LIVE_CAPTURE_IMAGE\",
\"metadata\": [{
\"key\": \"DEVICE\",
\"value\": \"IPHONE\"
}]
}",
"format" : "binary"
}
}
},
"NameElement" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"value" : {
"maxLength" : 100,
"minLength" : 1,
"pattern" : "^[\\p{L}0-9 /’‘',-]*$",
"type" : "string",
"description" : "value of name",
"example" : "typeName"
},
"verified" : {
"type" : "boolean",
"description" : "Describes the verification status of the parent field."
}
},
"description" : "Contains a section of the user's name. Can be one of the given names, a last name, or a full name (all sections in one string)."
},
"NationalityElement" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "Contains the ISO 3166-1 alpha-3 code referring to the country of the person's nationality.",
"example" : "USA",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CXR", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESP", "EST", "ETH", "EUE", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBD", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MOZ", "MSR", "MRT", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NER", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "RKS", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SHN", "SLB", "SLE", "SLV", "SMR", "SOM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VNM", "VUT", "WSM", "YEM", "ZAF", "ZMB", "ZWE", "UNK", "UNO", "UNA", "XOM", "XXA", "XXB", "XXC", "XXX", "ALA", "BLM", "ESH", "MAF", "MNP", "NCL", "NFK", "REU", "SGS", "SJM", "SPM", "TKL", "UMI", "VIR", "WLF", "BES", "CUW", "CYM", "GUM", "SXM", "ABR" ]
},
"verified" : {
"type" : "boolean",
"description" : "Describes the verification status of the parent field."
}
},
"description" : "Contains the ISO 3166-1 alpha-3 code for the country of the person's nationality."
},
"NfcSessionStatus" : {
"required" : [ "status" ],
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "The value of the status.",
"example" : "PROCESSING",
"enum" : [ "VERIFIED", "NOT_VERIFIED", "PROCESSING", "ADJUDICATION", "INVALID" ]
},
"type" : {
"type" : "string",
"description" : "The type of element the status is expressed for.",
"example" : "ID_DOCUMENT",
"default" : "ID_DOCUMENT"
},
"id" : {
"type" : "string",
"description" : "ID used to identify the status.",
"example" : "gips-998cf41c-6d76-45d2-b173-185854dc959f"
},
"errors" : {
"type" : "array",
"description" : "The list of errors associated with the status.",
"items" : {
"$ref" : "#/components/schemas/Error"
}
},
"sessionId" : {
"type" : "string",
"description" : "Unique identifier of the NFC session"
}
}
},
"OTP" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"value" : {
"maxLength" : 12,
"minLength" : 4,
"pattern" : "^[a-zA-Z0-9]*$",
"type" : "string",
"description" : "OTP code value"
}
}
},
"OTPElement" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "OTP status enum",
"enum" : [ "INITIATE", "NOT_INITIATED", "PENDING", "PROCESSING", "DONE", "ERROR", "TIMEOUT" ]
},
"creationTime" : {
"type" : "string",
"description" : "Date of creation of the OTP.",
"format" : "date-time"
},
"timeout" : {
"type" : "integer",
"description" : "Timeout of the OTP.",
"format" : "int32"
}
},
"description" : "Generic OTP element."
},
"OriginLanguageAddressData" : {
"type" : "object",
"properties" : {
"streetDetails" : {
"$ref" : "#/components/schemas/OriginLanguageStreetDetails"
},
"locality" : {
"type" : "string",
"description" : "Subdivision in address."
},
"postcode" : {
"type" : "string",
"description" : "Postal code or ZIP Code in address."
},
"city" : {
"type" : "string",
"description" : "City name in address."
},
"county" : {
"type" : "string",
"description" : "County name in address (UK)."
},
"state" : {
"type" : "string",
"description" : "If country is USA, state name uses USPS two-letter abbreviations. In all other cases, state name is written in full."
},
"country" : {
"type" : "string",
"description" : "Contains the ISO 3166-1 alpha-3 code referring to the country of the address."
}
},
"description" : "Contains all address-related data."
},
"OriginLanguageAttributesData" : {
"type" : "object",
"properties" : {
"givenNames" : {
"type" : "array",
"description" : "Contains a list of the person's given names.",
"items" : {
"type" : "string",
"description" : "Contains a list of the person's given names."
}
},
"surname" : {
"type" : "string",
"description" : "Contains the person's last name/surname."
},
"fullname" : {
"type" : "string",
"description" : "Contains the person's given names and last name/surname."
},
"nameAtBirth" : {
"type" : "string",
"description" : "Contains the person's name at birth."
},
"usageName" : {
"type" : "string",
"description" : "Contains any non-official name the person may go by."
},
"suffixName" : {
"type" : "string",
"description" : "Contains the name suffix."
},
"dateOfBirth" : {
"type" : "string",
"description" : "Contains date of birth."
},
"placeOfBirth" : {
"type" : "string",
"description" : "Contains place of birth."
},
"gender" : {
"type" : "string",
"description" : "Contains the person's gender."
},
"nationality" : {
"type" : "string",
"description" : "Contains the ISO 3166-1 alpha-3 code for the country of the person's nationality."
},
"eyeColor" : {
"type" : "string",
"description" : "Contains the person's eye color."
},
"height" : {
"type" : "string",
"description" : "Contains the person's height."
},
"weight" : {
"type" : "string",
"description" : "Contains the person's weight."
},
"personalNumber" : {
"type" : "string",
"description" : "Contains the person's national identity number."
},
"bloodGroup" : {
"type" : "string",
"description" : "Contains the person's blood group."
},
"relatives" : {
"type" : "array",
"description" : "Contains a list of the person's relatives.",
"items" : {
"$ref" : "#/components/schemas/OriginLanguageRelative"
}
},
"title" : {
"type" : "string",
"description" : "Contains the person's title."
},
"hairColor" : {
"type" : "string",
"description" : "Contains the person's hair color."
}
},
"description" : "This object contains all identity attributes that have been extracted from an identity evidence."
},
"OriginLanguageIdDocumentData" : {
"type" : "object",
"properties" : {
"idDocumentNumber" : {
"type" : "string",
"description" : "Document identifier as stated on the document."
},
"cardNumber" : {
"type" : "string",
"description" : "Card number as stated on the document."
},
"issuingCountry" : {
"type" : "string",
"description" : "Contains the the country that issued the document."
},
"issuingState" : {
"type" : "string",
"description" : "Name of the state that issued the document."
},
"supportDocumentIssuerCountry" : {
"type" : "string",
"description" : "Name of the country that issued the supported document."
},
"issuingAuthority" : {
"type" : "string",
"description" : "Name of the authority that issued the document."
},
"issuingDate" : {
"type" : "string",
"description" : "Date on which the document was issued."
},
"expiryDate" : {
"type" : "string",
"description" : "Date on which the document will expire."
},
"personalAttributes" : {
"$ref" : "#/components/schemas/OriginLanguageAttributesData"
},
"address" : {
"$ref" : "#/components/schemas/OriginLanguageAddressData"
},
"originLanguage" : {
"type" : "string",
"description" : "Contains the origin language."
}
},
"description" : "Contains all information related to the ID document."
},
"OriginLanguageRelative" : {
"type" : "object",
"properties" : {
"relativeFullName" : {
"type" : "string",
"description" : "Contains the person's given names and surname (last name)."
},
"relativeType" : {
"type" : "string",
"description" : "States the person's relationship to the document holder."
}
},
"description" : "Name and relation to user of a user's relatives."
},
"OriginLanguageStreetDetails" : {
"type" : "object",
"properties" : {
"houseNumber" : {
"type" : "string",
"description" : "House number in street address."
},
"flatNumber" : {
"type" : "string",
"description" : "Apartment identifier in building."
},
"houseName" : {
"type" : "string",
"description" : "House name in street address."
},
"streetLines" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "Street name in address."
}
},
"district" : {
"type" : "string",
"description" : "District name in address.",
"example" : "Columbia"
},
"verified" : {
"type" : "boolean",
"description" : "Validation status of street address information."
}
},
"description" : "Contains street address."
},
"PartnerAssessmentEvidence" : {
"required" : [ "evidenceId", "submitDateTime", "trustedIdClaimData", "type" ],
"type" : "object",
"properties" : {
"confidence" : {
"type" : "integer",
"format" : "int32"
},
"confidenceVersion" : {
"type" : "string"
},
"documentId" : {
"type" : "string"
},
"documentType" : {
"type" : "string"
},
"documentJurisdiction" : {
"type" : "string"
},
"country" : {
"type" : "string",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CXR", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESP", "EST", "ETH", "EUE", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBD", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MOZ", "MSR", "MRT", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NER", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "RKS", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SHN", "SLB", "SLE", "SLV", "SMR", "SOM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VNM", "VUT", "WSM", "YEM", "ZAF", "ZMB", "ZWE", "UNK", "UNO", "UNA", "XOM", "XXA", "XXB", "XXC", "XXX", "ALA", "BLM", "ESH", "MAF", "MNP", "NCL", "NFK", "REU", "SGS", "SJM", "SPM", "TKL", "UMI", "VIR", "WLF", "BES", "CUW", "CYM", "GUM", "SXM", "ABR" ]
},
"liveness" : {
"type" : "integer",
"format" : "int32"
},
"livenessVersion" : {
"type" : "string"
},
"gesture" : {
"type" : "integer",
"format" : "int32"
},
"gestureVersion" : {
"type" : "string"
},
"credentialId" : {
"type" : "string"
},
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
},
"idpIdentifier" : {
"type" : "string",
"description" : "Contains the partner identity",
"example" : "RACCOON"
},
"trustedIdClaimData" : {
"$ref" : "#/components/schemas/IdDocumentData"
}
},
"description" : "Contains partner assessment associated with the identity."
},
"PersonalNumberElement" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"value" : {
"maxLength" : 20,
"minLength" : 1,
"pattern" : "^[\\p{L}0-9 @+.’‘'”,\\/\\[\\]\\(\\)\\-]*$",
"type" : "string",
"description" : "Value of the parent field.",
"example" : "typeElement"
},
"verified" : {
"type" : "boolean",
"description" : "Describes the verification status of the parent field."
},
"issuingCountry" : {
"type" : "string",
"description" : "Contains the ISO 3166-1 alpha-3 code for the country of the person's nationality.",
"example" : "USA",
"enum" : [ "ABW", "AFG", "AGO", "AIA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CXR", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESP", "EST", "ETH", "EUE", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBD", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MOZ", "MSR", "MRT", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NER", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "RKS", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SHN", "SLB", "SLE", "SLV", "SMR", "SOM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VNM", "VUT", "WSM", "YEM", "ZAF", "ZMB", "ZWE", "UNK", "UNO", "UNA", "XOM", "XXA", "XXB", "XXC", "XXX", "ALA", "BLM", "ESH", "MAF", "MNP", "NCL", "NFK", "REU", "SGS", "SJM", "SPM", "TKL", "UMI", "VIR", "WLF", "BES", "CUW", "CYM", "GUM", "SXM", "ABR" ]
}
},
"description" : "The person's national identity number."
},
"PhoneElement" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"value" : {
"maxLength" : 20,
"minLength" : 2,
"pattern" : "^[0-9 +\\(\\).\\[\\]-]*$",
"type" : "string",
"description" : "Value of the parent field.",
"example" : "typeElement"
},
"verified" : {
"type" : "boolean",
"description" : "Describes the verification status of the parent field."
},
"otp" : {
"$ref" : "#/components/schemas/OTPElement"
},
"language" : {
"type" : "string"
},
"system" : {
"type" : "string"
},
"errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Error"
}
}
},
"description" : "Mobile phone number that can be used to contact the user. For example : +14999999999",
"example" : "+14999999999"
},
"Portrait" : {
"required" : [ "evidenceId", "submitDateTime", "type" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
},
"portraitQuality" : {
"type" : "boolean",
"description" : "Indicator of the quality of the submitted user portrait for biometric verification."
},
"livenessDiagnostic" : {
"type" : "string",
"description" : "Diagnostic of liveness in case where it is not possible to conclude on liveness status"
},
"portraitData" : {
"$ref" : "#/components/schemas/PortraitData"
}
},
"description" : "Contains all portrait processing details."
},
"PortraitData" : {
"required" : [ "source" ],
"type" : "object",
"properties" : {
"source" : {
"type" : "string",
"description" : "Describes how the portrait was captured.",
"example" : "LIVE_CAPTURE_IMAGE",
"enum" : [ "LIVE_CAPTURE_IMAGE", "LIVE_CAPTURE_VIDEO", "SCAN", "DOCUMENT_CROP", "DOCUMENT_ROTATION", "NFC", "SOR", "OTHER" ]
},
"metadata" : {
"type" : "array",
"description" : "May contain additional information depending on use case.",
"items" : {
"$ref" : "#/components/schemas/Metadata"
}
},
"osType" : {
"type" : "string",
"description" : "Mobile os type.",
"example" : "Android."
},
"osVersion" : {
"type" : "string",
"description" : "Version of phone OS.",
"example" : "7.0"
},
"deviceModel" : {
"type" : "string",
"description" : "The phone model.",
"example" : "Samsung Galaxy S7"
},
"channel" : {
"type" : "string",
"description" : "The channel used for the liveness challenge.",
"example" : "nativeSDK"
}
},
"description" : "Contains data related to the submitted user portrait."
},
"PortraitReference" : {
"required" : [ "portrait", "score" ],
"type" : "object",
"properties" : {
"portrait" : {
"type" : "string",
"description" : "base 64 data that represent user portrait",
"example" : "iVBORw0KGgoAAAANSUhEUgAAAHoAAAAHCAIAAABIh86sAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAmSURBVEhL7dAxAQAADMOg+TfdueAKErgFqpuqm6qbqpuqm6ob2h7KafiGGrOo+wAAAABJRU5ErkJggg=="
},
"score" : {
"type" : "string",
"description" : "Score of the submitted user portrait.",
"example" : "LEVEL2",
"enum" : [ "LEVEL1", "LEVEL2", "LEVEL3", "LEVEL4" ]
}
}
},
"PortraitReferenceEvidence" : {
"required" : [ "evidenceId", "submitDateTime", "type" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
}
},
"description" : "Contains claimed portrait associated with the identity."
},
"PortraitReferenceResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"portraitReference" : {
"$ref" : "#/components/schemas/PortraitReferenceEvidence"
}
}
},
"PortraitResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"portrait" : {
"$ref" : "#/components/schemas/Portrait"
}
}
},
"Relative" : {
"required" : [ "relativeType" ],
"type" : "object",
"properties" : {
"relativeFullName" : {
"maxLength" : 100,
"minLength" : 1,
"type" : "string",
"description" : "Contains the person's given names and surname (last name).",
"example" : "Paul DUPONT"
},
"relativeType" : {
"type" : "string",
"description" : "States the person's relationship to the document holder.",
"example" : "FATHER",
"enum" : [ "FATHER", "MOTHER", "HUSBAND", "WIFE", "SON", "DAUGHTER", "GUARDIAN", "SIBLING" ]
},
"verified" : {
"type" : "boolean",
"description" : "Validation status of the relative-related data.",
"example" : true
}
},
"description" : "Name and relation to user of a user's relatives."
},
"Sides" : {
"type" : "object",
"properties" : {
"fromDate" : {
"type" : "string",
"description" : "Describes an issuing date limit for which the supported document rule applies. Documents should not be issued before this date.",
"format" : "date",
"example" : "2020-01-01"
},
"toDate" : {
"type" : "string",
"description" : "Describes an issuing date limit for which the supported document rule applies. Documents should not be issued after this date.",
"format" : "date",
"example" : "2030-01-01"
},
"front" : {
"type" : "string",
"description" : "Describes the rules that apply to the front side of the document.",
"enum" : [ "MANDATORY", "OPTIONAL", "FORBIDDEN" ]
},
"back" : {
"type" : "string",
"description" : "Describes the rules that apply to the reverse side (back) of the document.",
"enum" : [ "MANDATORY", "OPTIONAL", "FORBIDDEN" ]
}
},
"description" : "Definitions of supported document sides for a given document type."
},
"SingleStatus" : {
"required" : [ "status" ],
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "The value of the status.",
"example" : "PROCESSING",
"enum" : [ "VERIFIED", "NOT_VERIFIED", "PROCESSING", "ADJUDICATION", "INVALID" ]
},
"type" : {
"type" : "string",
"description" : "The type of element the status is expressed for.",
"example" : "ID_DOCUMENT",
"default" : "ID_DOCUMENT"
},
"id" : {
"type" : "string",
"description" : "ID used to identify the status.",
"example" : "gips-998cf41c-6d76-45d2-b173-185854dc959f"
},
"errors" : {
"type" : "array",
"description" : "The list of errors associated with the status.",
"items" : {
"$ref" : "#/components/schemas/Error"
}
}
}
},
"StreetDetails" : {
"type" : "object",
"properties" : {
"houseNumber" : {
"maxLength" : 20,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9 ]*$",
"type" : "string",
"description" : "House number in street address.",
"example" : "1600"
},
"flatNumber" : {
"maxLength" : 5,
"minLength" : 1,
"pattern" : "[0-9]*",
"type" : "string",
"description" : "Apartment identifier in building.",
"example" : "B"
},
"houseName" : {
"maxLength" : 100,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ\\s’‘'-\\.,\\(\\)]*$",
"type" : "string",
"description" : "House name in street address.",
"example" : "The White House"
},
"streetLines" : {
"maxItems" : 5,
"minItems" : 1,
"type" : "array",
"items" : {
"type" : "string",
"description" : "Street name in address.",
"example" : "Pennsylvania Avenue"
}
},
"district" : {
"maxLength" : 100,
"minLength" : 1,
"pattern" : "^[A-Za-z0-9àáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžśÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ðŚ\\s’‘'-\\.,\\(\\)]*$",
"type" : "string",
"description" : "District name in address.",
"example" : "Columbia"
},
"verified" : {
"type" : "boolean",
"description" : "Validation status of street address information.",
"example" : true
}
},
"description" : "Contains street address."
},
"SupportedDocumentsResponse" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string",
"description" : "Additional comments. For future use."
},
"iso3CountryCode" : {
"type" : "string",
"description" : "Contains the ISO 3166-1 alpha-3 code for the country.",
"example" : "USA"
},
"documents" : {
"type" : "array",
"description" : "List of documents supported by the country in the iso3CountryCode field.",
"items" : {
"$ref" : "#/components/schemas/DocumentConf"
}
},
"IDClaim" : {
"$ref" : "#/components/schemas/IdClaimConf"
}
}
},
"TrustedIdClaimEvidence" : {
"required" : [ "evidenceId", "submitDateTime", "trustedIdClaimData", "type" ],
"type" : "object",
"properties" : {
"evidenceId" : {
"type" : "string",
"description" : "A unique identifier assigned to the evidence.",
"example" : "6ca28781-6d87-4964-92d3-d67c503a8548"
},
"submitDateTime" : {
"type" : "string",
"description" : "Timestamp of when the request was submitted.",
"format" : "date-time"
},
"type" : {
"type" : "string",
"description" : "Evidence type.",
"example" : "PASSPORT",
"enum" : [ "IDENTITY", "PASSPORT", "EPASSPORT", "IDENTITY_CARD", "RESIDENT_CARD", "BIOMETRICS", "TWODDOC", "ACCOUNT", "BANK_ACCOUNT", "BIRTH_CERTIFICATE", "MARRIAGE_CERTIFICATE", "POLL_CARD", "ADDRESS", "EMAIL", "MOBILE_OTP", "MAIL_OTP", "SMS_OTP", "CREDIT_CARD", "JUSTICE_ACT", "DRIVING_LICENSE", "TAX_SHEET", "UTILITY_BILL", "CONSENT", "AML", "CCMID", "ADJUDICATION_RESULT", "ATTRIBUTES", "ID_DOCUMENT", "REMOTE_ID", "PORTRAIT", "VISA", "CERTIFICATE", "ID_DOCUMENT_DATA", "TAX_CARD", "VOTER_CARD", "TRUSTED_ID_CLAIM", "ID_CLAIM", "PORTRAIT_REFERENCE", "PARTNER_ASSESSMENT", "ADDITIONAL_FILE", "UNKNOWN", "MEDICARE", "WORK_PERMIT", "CLAIMED_PORTRAIT" ]
},
"url" : {
"type" : "string",
"description" : "URL for accessing the submitted evidence."
},
"evidenceStatus" : {
"$ref" : "#/components/schemas/EvidenceStatus"
},
"idpIdentifier" : {
"type" : "string",
"description" : "Idp identifier enum",
"example" : "MIDSERVER",
"enum" : [ "MIDSERVER", "FRANCECONNECT" ]
},
"userIdentifier" : {
"type" : "string",
"description" : "Contains the end-user identifier used as login for online authentication.",
"example" : "xyz"
},
"oidcGrantType" : {
"type" : "string",
"description" : "OIDC grant type enum",
"example" : "authorization_code",
"enum" : [ "authorization_code" ]
},
"portraitReferenceId" : {
"type" : "string",
"description" : "Identifier of the reference portrait submitted with the trusted identity claimed."
},
"trustedIdClaimData" : {
"$ref" : "#/components/schemas/IdDocumentData"
}
},
"description" : "Contains a list of trusted Id Claims associated with the identity."
},
"TrustedIdClaimOidc" : {
"required" : [ "idpIdentifier" ],
"type" : "object",
"properties" : {
"idpIdentifier" : {
"type" : "string",
"description" : "Idp identifier enum",
"example" : "MIDSERVER",
"enum" : [ "MIDSERVER", "FRANCECONNECT" ]
},
"userIdentifier" : {
"type" : "string",
"description" : "Contains the end-user identifier used as login for online authentication.",
"example" : "xyz"
},
"oidcGrantType" : {
"type" : "string",
"description" : "OIDC grant type enum",
"example" : "authorization_code",
"enum" : [ "authorization_code" ]
},
"responseType" : {
"type" : "string",
"description" : "Response type enum",
"example" : "HTTP_REDIRECT",
"enum" : [ "HTTP_REDIRECT", "JSON" ]
},
"postAuthRedirectUri" : {
"type" : "string",
"description" : "Contains the redirection URI (user agent callback uri) at the end of the authentication process when IPV receives the callback with the authentication code.",
"example" : "https://client.redirecturi.com"
}
}
},
"TrustedIdClaimResponse" : {
"type" : "object",
"properties" : {
"globalStatus" : {
"$ref" : "#/components/schemas/IdentityStatus"
},
"trustedIdClaim" : {
"$ref" : "#/components/schemas/TrustedIdClaimEvidence"
}
}
},
"Username" : {
"required" : [ "username" ],
"type" : "object",
"properties" : {
"username" : {
"maxLength" : 100,
"minLength" : 0,
"pattern" : "^[A-Za-z0-9-_]*$",
"type" : "string",
"description" : "Username for user account."
},
"errors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Error"
}
}
},
"description" : "Name used to contact the user.",
"example" : "John"
},
"ValidityPeriod" : {
"type" : "object",
"properties" : {
"from" : {
"pattern" : "^(\\d{4}\\-(((0[13578]|1[02])-(0[1-9]|1[0-9]|2[0-9]|3[01]))|((0[469]|11)-(0[1-9]|1[0-9]|2[0-9]|30))|(02-(0[1-9]|1[0-9]|2[0-9])))([tT](([01]\\d|2[0123]):([012345]\\d):([012345]\\d)))?)([zZ]|([+\\-])(\\d\\d):?(\\d\\d))?$",
"type" : "string",
"description" : "Indicates the date on which the validity period begins.",
"example" : "2020-01-01"
},
"to" : {
"pattern" : "^(\\d{4}\\-(((0[13578]|1[02])-(0[1-9]|1[0-9]|2[0-9]|3[01]))|((0[469]|11)-(0[1-9]|1[0-9]|2[0-9]|30))|(02-(0[1-9]|1[0-9]|2[0-9])))([tT](([01]\\d|2[0123]):([012345]\\d):([012345]\\d)))?)([zZ]|([+\\-])(\\d\\d):?(\\d\\d))?$",
"type" : "string",
"description" : "Indicates the date on which the validity period ends.",
"example" : "2030-01-01"
}
},
"description" : "Period during which the information is considered valid."
}
}
}
}