# Get request identification detail.

Endpoint: GET /request/{id}/identification
Version: 2.0.0
Security: ApiKeyAuth

## Path parameters:

  - `id` (string, required)

## Query parameters:

  - `identificationId` (string)
    If not set, the endpoint returns the last identification.

  - `actor` (string)
    The id of the actor. According to the endpoint it may be required if multiple actors are defined
for the requestType.

## Response 200 fields (application/json):

  - `organizationId` (string)

  - `personData` (object)

  - `personData.lastName` (string)
    Example: "Doe"

  - `personData.firstName` (string)
    Example: "John"

  - `personData.birthDate` (string)

  - `personData.birthPlace` (string)
    Example: "FIRENZE"

  - `personData.personalNumber` (string)
    Personal identification number used in the country.
For instance, in Italy is "Codice Fiscale".
    Example: "DNTCRL65S67M126L"

  - `personData.gender` (string)
    Enum: "M", "F", "X"

  - `personData.nationality` (string)
    Country codes format follows the standard ISO 3166-1 alpha-2 with additional values for special cases according to ICAO 9303.
    Example: "IT"

  - `personData.phoneNumber` (string)
    Example: "+393331112233"

  - `personData.address` (object)

  - `personData.address.address` (string)
    It may or may not contain the address number.
    Example: "Via del Mondo 9"

  - `personData.address.city` (string)
    Example: "Firenze"

  - `personData.address.country` (string)
    Country codes format follows the standard ISO 3166-1 alpha-2 with additional values for special cases according to ICAO 9303.
    Example: "IT"

  - `personData.address.zipcode` (string)
    Example: "80123-SOUTH"

  - `personData.address.province` (string)
    Optional
    Example: "FI"

  - `personData.address.streetNumber` (string)
    The street number, if available by the identification source
(it may be present or missing in the address. It may be null regardless being present in the address).
    Example: "3bis"

  - `personData.email` (string)
    Example: "jjdoe@example.com"

  - `personData.documentDetails` (object)

  - `personData.documentDetails.issuanceCountry` (string)
    Country codes format follows the standard ISO 3166-1 alpha-2 with additional values for special cases according to ICAO 9303.
    Example: "IT"

  - `personData.documentDetails.issuanceAuthority` (string)
    Body who issued the document.
    Example: "Grand Ministry of Documents"

  - `personData.documentDetails.type` (string)
    Values may be added overtime.
List of values: 
- 'IdentityCard'
- 'DriverLicense'
- 'Passport'
- 'ResidencePermit'
- 'ItalianTS'
- 'Undefined'
    Example: "Passport"

  - `personData.documentDetails.number` (string)
    Example: "CA19498568Y"

  - `personData.documentDetails.issuedOn` (string)

  - `personData.documentDetails.expiryDate` (string)

  - `personData.documentDetails.mrz` (array)

  - `validationDetail` (object)

  - `validationDetail.personalNumber` (object)
    - requestMatched: If this element matches the corresponding parameter passed in the create request.
- otpValidated: If the element has been verified using an otp (eg. by email or sms).
- byIdentificationSource: If the element has been derived from the identification source.

  - `validationDetail.personalNumber.requestMatched` (string)
    The entry may be missing or null. Values may be added overtime.
Values:
- OK: The value has been matched or extracted.
- NOT_OK: The value has not been matched or extracted.
- SKIPPED: The value check has not been performed.
    Example: "OK"

  - `validationDetail.personalNumber.otpValidated` (string)
    The entry may be missing or null. Values may be added overtime.
Values:
- OK: The value has been matched or extracted.
- NOT_OK: The value has not been matched or extracted.
- SKIPPED: The value check has not been performed.
    Example: "OK"

  - `validationDetail.personalNumber.byIdentificationSource` (string)
    The entry may be missing or null. Values may be added overtime.
Values:
- OK: The value has been matched or extracted.
- NOT_OK: The value has not been matched or extracted.
- SKIPPED: The value check has not been performed.
    Example: "OK"

  - `validationDetail.personalNumber.byRequestInput` (string)
    The entry may be missing or null. Values may be added overtime.
Values:
- OK: The value has been matched or extracted.
- NOT_OK: The value has not been matched or extracted.
- SKIPPED: The value check has not been performed.
    Example: "OK"

  - `validationDetail.lastName` (object)
    - requestMatched: If this element matches the corresponding parameter passed in the create request.
- otpValidated: If the element has been verified using an otp (eg. by email or sms).
- byIdentificationSource: If the element has been derived from the identification source.

  - `validationDetail.firstName` (object)
    - requestMatched: If this element matches the corresponding parameter passed in the create request.
- otpValidated: If the element has been verified using an otp (eg. by email or sms).
- byIdentificationSource: If the element has been derived from the identification source.

  - `validationDetail.birthDate` (object)
    - requestMatched: If this element matches the corresponding parameter passed in the create request.
- otpValidated: If the element has been verified using an otp (eg. by email or sms).
- byIdentificationSource: If the element has been derived from the identification source.

  - `validationDetail.gender` (object)
    - requestMatched: If this element matches the corresponding parameter passed in the create request.
- otpValidated: If the element has been verified using an otp (eg. by email or sms).
- byIdentificationSource: If the element has been derived from the identification source.

  - `validationDetail.phoneNumber` (object)
    - requestMatched: If this element matches the corresponding parameter passed in the create request.
- otpValidated: If the element has been verified using an otp (eg. by email or sms).
- byIdentificationSource: If the element has been derived from the identification source.

  - `validationDetail.email` (object)
    - requestMatched: If this element matches the corresponding parameter passed in the create request.
- otpValidated: If the element has been verified using an otp (eg. by email or sms).
- byIdentificationSource: If the element has been derived from the identification source.

  - `validationDetail.documentNumber` (object)
    - requestMatched: If this element matches the corresponding parameter passed in the create request.
- otpValidated: If the element has been verified using an otp (eg. by email or sms).
- byIdentificationSource: If the element has been derived from the identification source.

  - `operator` (object)

  - `operator.idSelf` (object)

  - `operator.idSelf.receivedAt` (object)
    Example: "2024-10-22T12:19:12.269594Z"

  - `operator.idSelf.receivedAt.dummy` (string)

  - `operator.idSelf.response` (object)

  - `operator.idSelf.response.documentType` (string)
    Values may be added overtime.
List of values: 
- 'IdentityCard'
- 'DriverLicense'
- 'Passport'
- 'ResidencePermit'
- 'ItalianTS'
- 'Undefined'
    Example: "Passport"

  - `operator.idSelf.response.documentTypeFamily` (string)
    Values may be added overtime.
List of values: 
- 'IDENTITY_DOCUMENT'
- 'UNDEFINED'
    Example: "IDENTITY_DOCUMENT"

  - `operator.idSelf.response.controlsSummary` (integer)
    0: all controls are fine.
-1: at least one quality error
-2: at least one document conformity error
-3: at least one document consistency or authenticity error
    Example: -1

  - `operator.idSelf.response.keysWithError` (array)
    list of controls keys paths with status KO or FAILED.
    Example: ["holder.documentConsistency.firstNameFound"]

  - `operator.idSelf.personDataSnapshotBeforeOperatorCheck` (object)

  - `operator.idSelf.dataChanged` (array)

  - `operator.idSelf.dataChanged.key` (string)

  - `operator.idSelf.dataChanged.oldValue` (string)

  - `operator.idSelf.dataChanged.newValue` (string)

  - `operator.idSelf.operatorCheckResponse` (object)

  - `operator.idSelf.operatorCheckResponse.status` (string)
    Enum: "SUCCESS", "FAILED"

  - `operator.idSelf.operatorCheckResponse.message` (string)

  - `operator.idSelf.operatorCheckResponse.areElementsReadable` (boolean)

  - `operator.idSelf.operatorCheckResponse.liveCheckAnalysisUuid` (string)

  - `operator.idSelf.operatorCheckResponse.refuseReasonEnum` (string)

  - `operator.idSelfStartedAt` (object)
    Example: "2024-10-22T12:19:12.269594Z"

  - `operator.idSelfStartedAt.dummySeeComment` (string)

  - `operator.internalOperator` (object)

  - `operator.internalOperator.reviewPersonData` (object)

  - `operator.internalOperator.reviewPersonData.personalNumber` (object)

  - `operator.internalOperator.reviewPersonData.personalNumber.value` (string)

  - `operator.internalOperator.reviewPersonData.personalNumber.operatorConfiguration` (object)

  - `operator.internalOperator.reviewPersonData.personalNumber.operatorConfiguration.mode` (string, required)
    Enum: "DISABLED", "OPTIONAL", "REQUIRED"

  - `operator.internalOperator.reviewPersonData.personalNumber.operatorConfiguration.revisable` (boolean, required)

  - `operator.internalOperator.reviewPersonData.nationality` (object)

  - `operator.internalOperator.reviewPersonData.reviewDocumentDetails` (object)

  - `operator.internalOperator.reviewPersonData.reviewDocumentDetails.issuanceCountry` (object)

  - `operator.internalOperator.reviewPersonData.reviewDocumentDetails.issuanceCountry.value` (string)
    Country codes format follows the standard ISO 3166-1 alpha-2 with additional values for special cases according to ICAO 9303.
    Example: "IT"

  - `operator.internalOperator.reviewPersonData.reviewDocumentDetails.issuanceAuthority` (object)

  - `operator.internalOperator.reviewPersonData.reviewDocumentDetails.type` (object)

  - `operator.internalOperator.reviewPersonData.reviewDocumentDetails.type.value` (string)
    Values may be added overtime.
List of values: 
- 'IdentityCard'
- 'DriverLicense'
- 'Passport'
- 'ResidencePermit'
- 'ItalianTS'
- 'Undefined'
    Example: "Passport"

  - `operator.internalOperator.reviewedAt` (object)
    Example: "2024-10-22T12:19:12.269594Z"

  - `operator.internalOperator.rejected` (boolean)
    this field is true if at least one field has been rejected by operator

  - `spid` (object)

  - `spid.samlAssertion` (object)

  - `spid.samlAssertion.id` (string)

  - `spid.samlAssertion.filename` (string)
    Example: "audit_log.pdf"

  - `spid.samlAssertion.mimeType` (string)

  - `spid.samlAssertion.name` (string)
    Example: "Audit Log"

  - `spid.samlAssertion.type` (string)
    Values may be added overtime.
List of values: 
  - 'BIOMETRY_VIDEO'
  - 'BIOMETRY_IMAGE'
  - 'DOCUMENT_VIDEO'
  - 'DOCUMENT_IMAGE'
  - 'CONTRACT_DOCUMENT'
  - 'DOCUMENT'
  - 'IDENTITY_DOCUMENT'
  - 'SIGN_AUDIT_LOG'
  - 'IDP_ASSERTION'
  - 'AUDIT_TRAIL'
    Example: "BIOMETRY_VIDEO"

  - `spid.samlAssertion.family` (string)
    Values may be added overtime.
List of values: 
- 'IDENTIFICATION_ASSET'
- 'SIGNED_DOCUMENT'
- 'ATTACHMENT'
- 'PROOF'
- 'DOCUMENT_TO_SIGN'
    Example: "IDENTIFICATION_ASSET"

  - `spid.samlAssertion.subType` (string)
    Values may be added overtime.
List of values: 
- 'BEST_SELFIE'
- 'PROCESSED_FRONT_SIDE'
- 'PROCESSED_BACK_SIDE'
- 'SELFIE'
- 'FRONT_SIDE'
- 'BACK_SIDE'
- 'ID_PHOTO'
- 'PROOF_RAW'
- 'PROOF_RENDERED'
- 'DOCUMENT_FILLED'
- 'DOCUMENT_FLATTENED'
- 'APPLICATION_FORM'
    Example: "FRONT_SIDE"

  - `spid.samlAssertion.metadata` (object)

  - `spid.samlAssertion.metadata.additionalProp0` (string)

  - `spid.samlAssertion.resourceUrl` (string)
    Example: "https://storage.onboarding.example/res/121323?ts=12386ddd"

  - `spid.samlAssertion.urlValidBefore` (object)
    Example: "2024-10-22T12:19:12.269594Z"

  - `spid.samlAssertion.status` (string)
    Values may be added overtime.
List of values: 
- AVAILABLE -> Can be downloaded
- IN_TRANSFER -> The resource is still incomplete
- ABORTED -> The resource was not completed
- DELETED -> The resource was deleted
    Example: "AVAILABLE"

  - `spid.samlAssertion.resourceVersionId` (string)

  - `spid.samlAssertion.sizeBytes` (integer)

  - `spid.samlAssertion.checksum` (string)

  - `spid.spidCode` (string)
    Example: 123913921923

  - `spid.fiscalNumber` (string)
    Example: "INIT-DNTCRL65S67M126L"

  - `spid.familyName` (string)

  - `spid.placeOfBirth` (string)

  - `spid.dateOfBirth` (string)

  - `spid.expirationDate` (string)
    Present only in SPID Full.

  - `spid.countryOfBirth` (string)
    Present only in SPID Full.
    Example: "NA"

  - `spid.email` (string)
    Present only in SPID Full.

  - `spid.mobilePhone` (string)
    Present only in SPID Full.

  - `spid.address` (string)
    Present only in SPID Full.
    Example: "Via dei viali 8 00188 Napoli NA"

  - `spid.digitalAddress` (string)
    Present only in SPID Full.

  - `spid.idCard` (string)
    Present only in SPID Full.
    Example: "cartaIdentita ca972111al comuneNapoli 2007-11-19 2018-06-28"

  - `spid.companyName` (string)
    Present only in SPID Type 3

  - `spid.registeredOffice` (string)
    Present only in SPID Type 3

  - `spid.ivaCode` (string)
    Present only in SPID Type 3

  - `cie` (object)

  - `cie.idpAssertion` (object)

  - `germanId` (object)

  - `germanId.eidDocumentNumber` (string)

  - `germanId.issuingCountry` (string)

  - `germanId.documentType` (string)

  - `swissId` (object)

  - `austriaId` (object)

  - `itWallet` (object)

  - `itWallet.givenName` (string)

  - `itWallet.taxIdCode` (string)

  - `facephi` (object)

  - `facephi.documentNumber` (string)

  - `facephi.placeOfIssue` (string)

  - `facephi.artifacts` (object)
    Artifacts derived from the identification process. Eg. Back page of the document, front page of the document, etc.

  - `facephi.artifacts.biometry` (array)

  - `facephi.artifacts.document` (array)

  - `verifeye` (object)

  - `verifeye.issuedBy` (string)

  - `nfc` (object)

  - `nfc.biometryCheck` (object)

  - `nfc.biometryCheck.artifacts` (object)
    Artifacts derived from the identification process. Eg. Video of the document, front page of the document, etc.

  - `nfc.biometryCheck.documentCheck` (object)

  - `nfc.documentIdentification` (object)

  - `nfc.evidence` (object)

  - `actor` (string)
    Example: "customer"

  - `stepId` (string)

  - `status` (string)
    The status of the identification. Values may be added overtime.
Values:
  - PENDING
  - WAITING_FOR_APPROVAL
  - COMPLETED
  - REJECTED
  - FAILED
    Example: "COMPLETED"

  - `source` (string)
    The source of identification for the actor.
It may affect the presence of fields and details that are present in this Identification entity.
Values may be added overtime.
Values:
  - 'SPID'
  - 'ID-SELF'
    Example: "ID-SELF"

  - `finalizedAt` (object)
    Example: "2024-10-22T12:19:12.269594Z"

## Response 400 fields (application/problem+json):

  - `errors` (array)
    An array of error details to accompany a problem details response.

  - `errors.detail` (string, required)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "Property 'dummyField' is not defined in the schema and the schema does not allow additional properties."

  - `errors.pointer` (string)
    A JSON Pointer to a specific request body property that is the source of error.
    Example: "/parameters/dummyField"

  - `errors.field` (string)
    The name of the field that is the source of error.
    Example: "dummyField"

  - `errors.reason` (string)
    A machine oriented error type. Eg. additionalProperties, required
    Example: "additionalProperties"

  - `type` (string)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `status` (integer, required)
    The HTTP status code generated by the origin server for this occurrence of the problem.
    Example: 400

  - `title` (string)
    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
    Example: "Request validation error"

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463"

  - `retryable` (boolean)
    If the api call can be retried

## Response 404 fields (application/problem+json):

  - `type` (string)
    A URI reference that identifies the problem type.
    Example: "about:blank"

  - `status` (integer, required)
    The HTTP status code generated by the origin server for this occurrence of the problem.
    Example: 400

  - `title` (string)
    A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
    Example: "Request validation error"

  - `detail` (string)
    A human-readable explanation specific to this occurrence of the problem.
    Example: "The has a malformed body property."

  - `instance` (string)
    A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
    Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463"

  - `retryable` (boolean)
    If the api call can be retried