Content Comparison

OpenAPI YAML:

h1. Namirial Onboarding API

Namirial Onboarding API

Do you support non-breaking changes?
A non-breaking change means that we are able to change some aspects of the API and it should not affect your integration.
For instance, changes at API level listed below should not carry out any inconvenience to your integration:

• Adding new response fields.

• Adding new response headers.

• Adding new endpoints / operations.

• Adding new optional parameters in the requests.

• Changing the order of properties in existing API responses.

• Changing the length or format of strings and string based ids.

Version: 2.0.0

{expand:Table of Contents - Click to expand}
{toc:printable=true|style=square|minLevel=2|maxLevel=3|type=list|outline=false|include=.*}
{expand}

h2. Endpoints

h3. requestIdGet
{panel:title=requestIdGet|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
Summary: Get request
Description: No Description

|| HttpMethod | {status:colour=Yellow|title=get|subtle=false} |
|| Protocol | {noformat:nopanel=true}https{noformat} |
|| Path | {noformat:nopanel=true}/request/{id}{noformat} |
|| Base Path | {noformat:nopanel=true}<https://test-onboarding.namirial.app/api/v2{noformat}> |
|| Produces | {noformat:nopanel=true}application/json application/problem+json {noformat} |

h4. Parameters
h5. Path Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|id | | UUID | (/) |null | | |

h4. Responses

	|| Status Code | {status:colour=Green|title=200|subtle=false} |
	|| Message | The request |
	|| Response Type | Request |
	|| Response Model | [Request Model|#RequestModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "The request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Request"
}
}
}
}{code} |

	|| Status Code | {status:colour=Orange|title=404|subtle=false} |
	|| Message | Not Found described following Problem Details (RFC 9457) |
	|| Response Type | ProblemDetail |
	|| Response Model | [ProblemDetail Model|#ProblemDetailModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "Not Found described following Problem Details (RFC 9457)",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetail"
}
}
}
}{code} |

{panel}

h3. requestIdIdentificationIdGet
{panel:title=requestIdIdentificationIdGet|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
Summary: Get request identification detail.
Description: No Description

|| HttpMethod | {status:colour=Yellow|title=get|subtle=false} |
|| Protocol | {noformat:nopanel=true}https{noformat} |
|| Path | {noformat:nopanel=true}/request/{id}/identification{noformat} |
|| Base Path | {noformat:nopanel=true}<https://test-onboarding.namirial.app/api/v2{noformat}> |
|| Produces | {noformat:nopanel=true}application/json application/problem+json {noformat} |

h4. Parameters
h5. Path Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|id | | UUID | (/) |null | | |

h5. Query Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|identificationId |If not set, the endpoint returns the last identification. | UUID | (x) |null | | ||actor |The name of the actor. According to the endpoint it may be required if multiple actors are defined
for the requestType. | String | (x) |null | | |

h4. Responses

	|| Status Code | {status:colour=Green|title=200|subtle=false} |
	|| Message | The request identifications |
	|| Response Type | Identification |
	|| Response Model | [Identification Model|#IdentificationModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "The request identifications",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Identification"
}
}
}
}{code} |

	|| Status Code | {status:colour=Orange|title=400|subtle=false} |
	|| Message | Bad Request described following Problem Details (RFC 9457) |
	|| Response Type | ProblemBadRequest |
	|| Response Model | [ProblemBadRequest Model|#ProblemBadRequestModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "Bad Request described following Problem Details (RFC 9457)",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemBadRequest"
}
}
}
}{code} |

	|| Status Code | {status:colour=Orange|title=404|subtle=false} |
	|| Message | Not Found described following Problem Details (RFC 9457) |
	|| Response Type | ProblemDetail |
	|| Response Model | [ProblemDetail Model|#ProblemDetailModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "Not Found described following Problem Details (RFC 9457)",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemDetail"
}
}
}
}{code} |

{panel}

h3. requestIdIdentifications
{panel:title=requestIdIdentifications|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
Summary: Get request Identifications
Description: No Description

|| HttpMethod | {status:colour=Yellow|title=get|subtle=false} |
|| Protocol | {noformat:nopanel=true}https{noformat} |
|| Path | {noformat:nopanel=true}/request/{id}/identifications{noformat} |
|| Base Path | {noformat:nopanel=true}<https://test-onboarding.namirial.app/api/v2{noformat}> |
|| Produces | {noformat:nopanel=true}application/json {noformat} |

h4. Parameters
h5. Path Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|id | | UUID | (/) |null | | |

h4. Responses

	|| Status Code | {status:colour=Green|title=200|subtle=false} |
	|| Message | The request identifications |
	|| Response Type | RequestIdentifications |
	|| Response Model | [RequestIdentifications Model|#RequestIdentificationsModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "The request identifications",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RequestIdentifications"
}
}
}
}{code} |

{panel}

h3. requestIdLinksPost
{panel:title=requestIdLinksPost|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
Summary: Generate new links associated to a request. Previous links (if not expired) are still usable.
Description: No Description

|| HttpMethod | {status:colour=Yellow|title=post|subtle=false} |
|| Protocol | {noformat:nopanel=true}https{noformat} |
|| Path | {noformat:nopanel=true}/request/{id}/links{noformat} |
|| Base Path | {noformat:nopanel=true}<https://test-onboarding.namirial.app/api/v2{noformat}> |
|| Produces | {noformat:nopanel=true}application/json application/problem+json {noformat} |

h4. Parameters
h5. Path Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|id | | UUID | (/) |null | | |

h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|GenerateLinkRequest | | GenerateLinkRequest | (x) | | | |

h4. Responses

	|| Status Code | {status:colour=Green|title=200|subtle=false} |
	|| Message | The created request |
	|| Response Type | RequestLinks |
	|| Response Model | [RequestLinks Model|#RequestLinksModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "The created request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RequestLinks"
}
}
}
}{code} |

	|| Status Code | {status:colour=Orange|title=400|subtle=false} |
	|| Message | Bad Request described following Problem Details (RFC 9457) |
	|| Response Type | ProblemBadRequest |
	|| Response Model | [ProblemBadRequest Model|#ProblemBadRequestModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "Bad Request described following Problem Details (RFC 9457)",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemBadRequest"
}
}
}
}{code} |

{panel}

h3. requestsGet
{panel:title=requestsGet|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
Summary: Get requests
Description: Sorting Fields:

• createdAt

• updatedAt

Note: Due to caching mechanism the bulk view may not be in sync with single request detail view.

|| HttpMethod | {status:colour=Yellow|title=get|subtle=false} |
|| Protocol | {noformat:nopanel=true}https{noformat} |
|| Path | {noformat:nopanel=true}/requests{noformat} |
|| Base Path | {noformat:nopanel=true}<https://test-onboarding.namirial.app/api/v2{noformat}> |
|| Produces | {noformat:nopanel=true}application/json {noformat} |

h4. Parameters

h5. Query Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|sort |Not all fields are supported in sorting. See the description of the endpoint for the list of supported fields.
Specify the field to sort and the ordering (`asc`, or `desc`) separated by a coma. | String | (x) |null | | ||page |Page numbers starting at 0. | Long | (x) |null | | ||size |Size 0 equals to default size. Maximum size may be limited anytime and not honored by the backend. | Long | (x) |null | | ||status |Used to filter requests by their current status. | String | (x) |null | | ||referenceId |Used to filter requests by their referenceId. | String | (x) |null | | |

h4. Responses

	|| Status Code | {status:colour=Green|title=200|subtle=false} |
	|| Message | The fetched request |
	|| Response Type | RequestsPage |
	|| Response Model | [RequestsPage Model|#RequestsPageModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "The fetched request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RequestsPage"
}
}
}
}{code} |

{panel}

h3. requestsPost
{panel:title=requestsPost|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
Summary: Create a new request
Description: No Description

|| HttpMethod | {status:colour=Yellow|title=post|subtle=false} |
|| Protocol | {noformat:nopanel=true}https{noformat} |
|| Path | {noformat:nopanel=true}/requests{noformat} |
|| Base Path | {noformat:nopanel=true}<https://test-onboarding.namirial.app/api/v2{noformat}> |
|| Produces | {noformat:nopanel=true}application/json application/problem+json {noformat} |

h4. Parameters

h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|Request | | Request | (x) | | | |

h5. Query Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|idempotencyKey |Optional field. If the endpoint already have received a request with the same `IdempotencyKey` in the last 7 days
(+1 day: not strict, depending on operation scheduling) it replies with the same body that has been sent the first time. Please note, that entity in the body, may have
been updated in the meantime and those changes will not be present in any next replies.
The idempotency key should not be reused by the Integrator to refer to a different request, it is meant to be temporary, specific to reties of a single request to avoid duplications. | String | (x) |null | | |

h4. Responses

	|| Status Code | {status:colour=Green|title=200|subtle=false} |
	|| Message | The created request |
	|| Response Type | RequestCreateResponse |
	|| Response Model | [RequestCreateResponse Model|#RequestCreateResponseModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "The created request",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RequestCreateResponse"
}
}
}
}{code} |

	|| Status Code | {status:colour=Orange|title=400|subtle=false} |
	|| Message | Bad Request described following Problem Details (RFC 9457) |
	|| Response Type | ProblemBadRequest |
	|| Response Model | [ProblemBadRequest Model|#ProblemBadRequestModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "Bad Request described following Problem Details (RFC 9457)",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemBadRequest"
}
}
}
}{code} |

{panel}

h3. requestTypeIdWebhookConfigurationIdDelete
{panel:title=requestTypeIdWebhookConfigurationIdDelete|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
Summary: Delete the specified webhook setting
Description: No Description

|| HttpMethod | {status:colour=Yellow|title=delete|subtle=false} |
|| Protocol | {noformat:nopanel=true}https{noformat} |
|| Path | {noformat:nopanel=true}/requestType/{id}/webhookConfiguration/{webhookConfigurationId}{noformat} |
|| Base Path | {noformat:nopanel=true}<https://test-onboarding.namirial.app/api/v2{noformat}> |
|| Produces | {noformat:nopanel=true}application/problem+json {noformat} |

h4. Parameters
h5. Path Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|id | | UUID | (/) |null | | ||webhookConfigurationId | | UUID | (/) |null | | |

h4. Responses

	|| Status Code | {status:colour=Green|title=204|subtle=false} |
	|| Message | The resource was deleted successfully. |
	|| Response Type |  |
	|| Response Model | [ Model|#ModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "The resource was deleted successfully."
}{code} |

	|| Status Code | {status:colour=Orange|title=400|subtle=false} |
	|| Message | Bad Request described following Problem Details (RFC 9457) |
	|| Response Type | ProblemBadRequest |
	|| Response Model | [ProblemBadRequest Model|#ProblemBadRequestModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "Bad Request described following Problem Details (RFC 9457)",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemBadRequest"
}
}
}
}{code} |

{panel}

h3. requestTypeIdWebhookConfigurationPost
{panel:title=requestTypeIdWebhookConfigurationPost|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
Summary: Create request type webhooks setting
Description: No Description

|| HttpMethod | {status:colour=Yellow|title=post|subtle=false} |
|| Protocol | {noformat:nopanel=true}https{noformat} |
|| Path | {noformat:nopanel=true}/requestType/{id}/webhookConfigurations{noformat} |
|| Base Path | {noformat:nopanel=true}<https://test-onboarding.namirial.app/api/v2{noformat}> |
|| Produces | {noformat:nopanel=true}application/json application/problem+json {noformat} |

h4. Parameters
h5. Path Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|id | | UUID | (/) |null | | |

h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|WebhookConfiguration | | WebhookConfiguration | (x) | | | |

h4. Responses

	|| Status Code | {status:colour=Green|title=200|subtle=false} |
	|| Message | The webhook settings created |
	|| Response Type | WebhookConfiguration |
	|| Response Model | [WebhookConfiguration Model|#WebhookConfigurationModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "The webhook settings created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/WebhookConfiguration"
},
"example" : "{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"url\": \"https://your.domain/webhook\\",\n \"createdAt\": \"2024-10-22T12:19:12.269594Z\"\n}\n"
}
}
}{code} |

	|| Status Code | {status:colour=Orange|title=400|subtle=false} |
	|| Message | Bad Request described following Problem Details (RFC 9457) |
	|| Response Type | ProblemBadRequest |
	|| Response Model | [ProblemBadRequest Model|#ProblemBadRequestModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "Bad Request described following Problem Details (RFC 9457)",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/ProblemBadRequest"
}
}
}
}{code} |

{panel}

h3. requestTypeIdWebhookConfigurationsGet
{panel:title=requestTypeIdWebhookConfigurationsGet|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
Summary: Get request type webhooks configurations
Description: No Description

|| HttpMethod | {status:colour=Yellow|title=get|subtle=false} |
|| Protocol | {noformat:nopanel=true}https{noformat} |
|| Path | {noformat:nopanel=true}/requestType/{id}/webhookConfigurations{noformat} |
|| Base Path | {noformat:nopanel=true}<https://test-onboarding.namirial.app/api/v2{noformat}> |
|| Produces | {noformat:nopanel=true}application/json {noformat} |

h4. Parameters
h5. Path Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|id | | UUID | (/) |null | | |

h4. Responses

	|| Status Code | {status:colour=Green|title=200|subtle=false} |
	|| Message | The webhook configurations for the specified request type |
	|| Response Type | WebhookConfigurationsPage |
	|| Response Model | [WebhookConfigurationsPage Model|#WebhookConfigurationsPageModelAnchor|Jump to model] |
	|| Response Schema | {code:collapse=true}{

"description" : "The webhook configurations for the specified request type",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/WebhookConfigurationsPage"
},
"example" : "{\n \"content\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"url\": \"https://your.domain/webhook\\",\n \"createdAt\": \"2024-10-22T12:19:12.269594Z\"\n }\n ]\n}\n"
}
}
}{code} |

{panel}

{anchor:models}
h2. Models

    {anchor:AddressModelAnchor}
    h3. Address

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |address |(x) |{noformat:nopanel=true}String{noformat} | It may or may not contain the address number. |  | Via del Mondo 9
     |city |(x) |{noformat:nopanel=true}String{noformat} |  |  | Firenze
     |country |(x) |{noformat:nopanel=true}String{noformat} | Country codes format follows the standard ISO 3166-1 alpha-2 with additional values for special cases according to ICAO 9303. |  | IT
     |zipcode |(x) |{noformat:nopanel=true}String{noformat} |  |  | 80123-SOUTH
     |province |(x) |{noformat:nopanel=true}String{noformat} | Optional |  | FI
     |streetNumber |(x) |{noformat:nopanel=true}String{noformat} | 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). | | 3bis

    {anchor:BadRequestErrorModelAnchor}
    h3. BadRequestError

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |errors |(x) |{noformat:nopanel=true}array[map[String, Object]]{noformat} |  |  | null
     |id |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |at |(x) |{noformat:nopanel=true}Date{noformat} |  |  | null
     |message |(x) |{noformat:nopanel=true}String{noformat} |  |  | null
     |status |(x) |{noformat:nopanel=true}Integer{noformat} |  |  | null
     |retryable |(x) |{noformat:nopanel=true}Boolean{noformat} |  |  | null
     
    {anchor:FacematchIdentificationModelAnchor}
    h3. FacematchIdentification

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |artifacts |(x) |{noformat:nopanel=true}FacematchIdentificationArtifacts{noformat} |  |  | null
     |biometryCheck |(x) |{noformat:nopanel=true}FacematchIdentificationBiometryCheck{noformat} |  |  | null
     |documentCheck |(x) |{noformat:nopanel=true}FacematchIdentificationDocumentCheck{noformat} |  |  | null
     
    {anchor:FacematchIdentificationArtifactsModelAnchor}
    h3. FacematchIdentificationArtifacts

    Artifacts derived from the identification process. Eg. Video of the document, front page of the document, etc.

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |biometry |(x) |{noformat:nopanel=true}array[RequestResource]{noformat} |  |  | null
     |document |(x) |{noformat:nopanel=true}array[RequestResource]{noformat} |  |  | null
     
    {anchor:FacematchIdentificationBiometryCheckModelAnchor}
    h3. FacematchIdentificationBiometryCheck

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |controlsSummary |(x) |{noformat:nopanel=true}Integer{noformat} | 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 | | -1
|keysWithError |(x) |{noformat:nopanel=true}array[String]{noformat} | list of controls keys paths with status KO or FAILED. | | ["holder.documentConsistency.firstNameFound"]

    {anchor:FacematchIdentificationDocumentCheckModelAnchor}
    h3. FacematchIdentificationDocumentCheck

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |documentType |(x) |{noformat:nopanel=true}String{noformat} | Values may be added overtime.

List of values:

• 'IdentityCard'

• 'DriverLicense'

• 'Passport'

• 'ResidencePermit'

• 'ItalianTS'

• 'Undefined' | | Passport
  |documentTypeFamily |(x) |{noformat:nopanel=true}String{noformat} | Values may be added overtime.
  List of values:

• 'IDENTITY_DOCUMENT'

• 'UNDEFINED' | | IDENTITY_DOCUMENT
  |controlsSummary |(x) |{noformat:nopanel=true}Integer{noformat} | 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 | | -1
  |keysWithError |(x) |{noformat:nopanel=true}array[String]{noformat} | list of controls keys paths with status KO or FAILED. | | ["holder.documentConsistency.firstNameFound"]

  Code Block
  {anchor:GenderModelAnchor} h3. Gender ||Name||Value||Description|| |M |"M" | |

|F |"F" | |
|X |"X" | |

    {anchor:GenerateLinkRequestModelAnchor}
    h3. GenerateLinkRequest

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |onlyForActors |(x) |{noformat:nopanel=true}array[String]{noformat} | If not empty, it limits the generation only for the listed actors. Otherwise, it generates for all actors. |  | null
     
    {anchor:IdentificationModelAnchor}
    h3. Identification

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |organizationId |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |personData |(x) |{noformat:nopanel=true}PersonIdentification{noformat} |  |  | null
     |validationDetail |(x) |{noformat:nopanel=true}IdentificationValidationDetail{noformat} |  |  | null
     |facematch |(x) |{noformat:nopanel=true}FacematchIdentification{noformat} |  |  | null
     |spid |(x) |{noformat:nopanel=true}SpidIdentification{noformat} |  |  | null
     |id |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |actor |(x) |{noformat:nopanel=true}String{noformat} |  |  | customer
     |status |(x) |{noformat:nopanel=true}String{noformat} | The status of the identification. Values may be added overtime.

Values:

• PENDING

• WAITING_FOR_APPROVAL

• COMPLETED

• REJECTED

• FAILED | | COMPLETED
  |source |(x) |{noformat:nopanel=true}String{noformat} | 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'

• 'FACEMATCH' | | FACEMATCH
  |finalizedAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null

  Code Block
  {anchor:IdentificationSummaryModelAnchor} h3. IdentificationSummary ||Field Name||Required||Type||Description||Enum||Example|| |id |(x) |{noformat:nopanel=true}UUID{noformat} | | | null |actor |(x) |{noformat:nopanel=true}String{noformat} | | | customer |status |(x) |{noformat:nopanel=true}String{noformat} | The status of the identification. Values may be added overtime.

Values:

• PENDING

• WAITING_FOR_APPROVAL

• COMPLETED

• REJECTED

• FAILED | | COMPLETED
  |source |(x) |{noformat:nopanel=true}String{noformat} | 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'

• 'FACEMATCH' | | FACEMATCH
  |finalizedAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null

  Code Block

  {anchor:IdentificationValidationDetailModelAnchor} h3. IdentificationValidationDetail ||Field Name||Required||Type||Description||Enum||Example|| |personalNumber |(x) |{noformat:nopanel=true}IdentificationValidationDetailElement{noformat} | | | null |lastName |(x) |{noformat:nopanel=true}IdentificationValidationDetailElement{noformat} | | | null |firstName |(x) |{noformat:nopanel=true}IdentificationValidationDetailElement{noformat} | | | null |birthDate |(x) |{noformat:nopanel=true}IdentificationValidationDetailElement{noformat} | | | null |gender |(x) |{noformat:nopanel=true}IdentificationValidationDetailElement{noformat} | | | null |phoneNumber |(x) |{noformat:nopanel=true}IdentificationValidationDetailElement{noformat} | | | null |email |(x) |{noformat:nopanel=true}IdentificationValidationDetailElement{noformat} | | | null |documentNumber |(x) |{noformat:nopanel=true}IdentificationValidationDetailElement{noformat} | | | null {anchor:IdentificationValidationDetailElementModelAnchor} h3. IdentificationValidationDetailElement - 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.

  Code Block
  ||Field Name||Required||Type||Description||Enum||Example|| |requestMatched |(x) |{noformat:nopanel=true}String{noformat} | 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. | | OK
  |otpValidated |(x) |{noformat:nopanel=true}String{noformat} | 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. | | OK
  |byIdentificationSource |(x) |{noformat:nopanel=true}String{noformat} | 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. | | OK

  Code Block

  {anchor:ObjectNodeModelAnchor} h3. ObjectNode ||Field Name||Required||Type||Description||Enum||Example|| |additionalProp0 |(x) |{noformat:nopanel=true}String{noformat} | | | null {anchor:PageModelAnchor} h3. Page ||Field Name||Required||Type||Description||Enum||Example|| |size |(x) |{noformat:nopanel=true}Long{noformat} | the size of the pages. The last page can have less items, do not use as item counter the reply. | | 1 |number |(x) |{noformat:nopanel=true}Long{noformat} | zero-based page number, is not negative. | | 0 |totalElements |(x) |{noformat:nopanel=true}Long{noformat} | counter of elements matching the query. | | 4 |totalPages |(x) |{noformat:nopanel=true}Long{noformat} | counter of pages of the current size. | | 4 {anchor:PersonIdentificationModelAnchor} h3. PersonIdentification ||Field Name||Required||Type||Description||Enum||Example|| |lastName |(x) |{noformat:nopanel=true}String{noformat} | | | Doe |firstName |(x) |{noformat:nopanel=true}String{noformat} | | | John |birthDate |(x) |{noformat:nopanel=true}date{noformat} | | | null |birthPlace |(x) |{noformat:nopanel=true}String{noformat} | | | FIRENZE |personalNumber |(x) |{noformat:nopanel=true}String{noformat} | Personal identification number used in the country.

For instance, in Italy is "Codice Fiscale". | | DNTCRL65S67M126L
|gender |(x) |{noformat:nopanel=true}Gender{noformat} | | | null
|nationality |(x) |{noformat:nopanel=true}String{noformat} | Country codes format follows the standard ISO 3166-1 alpha-2 with additional values for special cases according to ICAO 9303. | | IT
|phoneNumber |(x) |{noformat:nopanel=true}String{noformat} | | | +393331112233
|address |(x) |{noformat:nopanel=true}Address{noformat} | | | null
|email |(x) |{noformat:nopanel=true}String{noformat} | | | jjdoe@example.com
|documentDetails |(x) |{noformat:nopanel=true}PersonIdentificationDocument{noformat} | | | null

    {anchor:PersonIdentificationDocumentModelAnchor}
    h3. PersonIdentificationDocument

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |issuanceCountry |(x) |{noformat:nopanel=true}String{noformat} | Country codes format follows the standard ISO 3166-1 alpha-2 with additional values for special cases according to ICAO 9303. |  | IT
     |issuanceAuthority |(x) |{noformat:nopanel=true}String{noformat} | Body who issued the document. |  | Grand Ministry of Documents
     |type |(x) |{noformat:nopanel=true}String{noformat} | Values may be added overtime.

List of values:

• 'IdentityCard'

• 'DriverLicense'

• 'Passport'

• 'ResidencePermit'

• 'ItalianTS'

• 'Undefined' | | Passport
  |number |(x) |{noformat:nopanel=true}String{noformat} | | | CA19498568Y
  |issuedOn |(x) |{noformat:nopanel=true}date{noformat} | | | null
  |expiryDate |(x) |{noformat:nopanel=true}date{noformat} | | | null

  Code Block

  {anchor:ProblemBadRequestModelAnchor} h3. ProblemBadRequest ||Field Name||Required||Type||Description||Enum||Example|| |errors |(x) |{noformat:nopanel=true}array[Object]{noformat} | An array of error details to accompany a problem details response. | | null |type |(x) |{noformat:nopanel=true}URI{noformat} | A URI reference that identifies the problem type. | | about:blank |status |(/) |{noformat:nopanel=true}Integer{noformat} | The HTTP status code generated by the origin server for this occurrence of the problem. | | 400 |title |(x) |{noformat:nopanel=true}String{noformat} | 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. | | Request validation error |detail |(x) |{noformat:nopanel=true}String{noformat} | A human-readable explanation specific to this occurrence of the problem. | | The has a malformed body property. |instance |(x) |{noformat:nopanel=true}String{noformat} | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. | | urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463 |retryable |(x) |{noformat:nopanel=true}Boolean{noformat} | If the api call can be retried | | false {anchor:ProblemDetailModelAnchor} h3. ProblemDetail ||Field Name||Required||Type||Description||Enum||Example|| |type |(x) |{noformat:nopanel=true}URI{noformat} | A URI reference that identifies the problem type. | | about:blank |status |(/) |{noformat:nopanel=true}Integer{noformat} | The HTTP status code generated by the origin server for this occurrence of the problem. | | 400 |title |(x) |{noformat:nopanel=true}String{noformat} | 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. | | Request validation error |detail |(x) |{noformat:nopanel=true}String{noformat} | A human-readable explanation specific to this occurrence of the problem. | | The has a malformed body property. |instance |(x) |{noformat:nopanel=true}String{noformat} | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. | | urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463 |retryable |(x) |{noformat:nopanel=true}Boolean{noformat} | If the api call can be retried | | false {anchor:RequestModelAnchor} h3. Request - `createdAt`: The instant of request creation.

• updatedAt: Last update instant.

• finalizedAt: The instant when the request reached a terminal status.

• expireAfter: The instant after which the request cannot be processed anymore, because it has not been completed on time.

  Code Block

  ||Field Name||Required||Type||Description||Enum||Example|| |id |(x) |{noformat:nopanel=true}UUID{noformat} | | | null |organizationId |(x) |{noformat:nopanel=true}UUID{noformat} | | | null |status |(x) |{noformat:nopanel=true}RequestStatus{noformat} | | | null |referenceId |(x) |{noformat:nopanel=true}String{noformat} | Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally.

More requests can have the same value. | | order-1234-0002
|requestTypeId |(/) |{noformat:nopanel=true}UUID{noformat} | Identifier of the type of process associated to the request. This identifier is given to the Integrator
during initial setup of the integration project. | | null
|parameters |(x) |{noformat:nopanel=true}ObjectNode{noformat} | | | null
|createdAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null
|updatedAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null
|finalizedAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null
|expireAfter |(x) |{noformat:nopanel=true}Date{noformat} | | | null

    {anchor:RequestCreateResponseModelAnchor}
    h3. RequestCreateResponse

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |id |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |organizationId |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |status |(x) |{noformat:nopanel=true}RequestStatus{noformat} |  |  | null
     |referenceId |(x) |{noformat:nopanel=true}String{noformat} | Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally.

More requests can have the same value. | | order-1234-0002
|requestTypeId |(/) |{noformat:nopanel=true}UUID{noformat} | Identifier of the type of process associated to the request. This identifier is given to the Integrator
during initial setup of the integration project. | | null
|parameters |(x) |{noformat:nopanel=true}ObjectNode{noformat} | | | null
|createdAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null
|updatedAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null
|finalizedAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null
|expireAfter |(x) |{noformat:nopanel=true}Date{noformat} | | | null
|links |(x) |{noformat:nopanel=true}array[RequestLink]{noformat} | | | null

    {anchor:RequestErrorModelAnchor}
    h3. RequestError

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |id |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |at |(x) |{noformat:nopanel=true}Date{noformat} |  |  | null
     |message |(x) |{noformat:nopanel=true}String{noformat} |  |  | null
     |status |(x) |{noformat:nopanel=true}Integer{noformat} |  |  | null
     |retryable |(x) |{noformat:nopanel=true}Boolean{noformat} |  |  | null
     
    {anchor:RequestIdentificationsModelAnchor}
    h3. RequestIdentifications

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |requestId |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |identifications |(x) |{noformat:nopanel=true}array[IdentificationSummary]{noformat} |  |  | null
     
    {anchor:RequestLinkModelAnchor}
    h3. RequestLink

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |actor |(x) |{noformat:nopanel=true}String{noformat} |  |  | customer
     |link |(x) |{noformat:nopanel=true}String{noformat} |  |  | <https://onboarding.example/res/3949?ts&#x3D;49943>
     |expiresAfter |(x) |{noformat:nopanel=true}Date{noformat} |  |  | null
     
    {anchor:RequestLinksModelAnchor}
    h3. RequestLinks

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |links |(x) |{noformat:nopanel=true}array[RequestLink]{noformat} |  |  | null
     
    {anchor:RequestNotificationModelAnchor}
    h3. RequestNotification

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |id |(x) |{noformat:nopanel=true}UUID{noformat} | Id of the notification |  | null
     |type |(x) |{noformat:nopanel=true}String{noformat} | The type of updated that caused the notification.

Values may be added overtime.
List of values:

• STATUS_UPDATE | | STATUS_UPDATE
  |createdAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null
  |request |(x) |{noformat:nopanel=true}RequestNotificationBody{noformat} | | | null

  Code Block
  {anchor:RequestNotificationAuthenticationModelAnchor} h3. RequestNotificationAuthentication ||Field Name||Required||Type||Description||Enum||Example|| |headers |(x) |{noformat:nopanel=true}map[String, String]{noformat} | | | null |client_key |(x) |{noformat:nopanel=true}String{noformat} | PEM format client key (not visible in get) | | -----BEGIN RSA PRIVATE KEY-----

MIIH/TCCBeWgAwIBAgIQaBYE3/M08XHYCnNVmcFBcjANBgkqhkiG9w0BAQsFADBy
MQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxEDAOBgNVBAcMB0hvdXN0b24x
ETAPBgNVBAoMCFNTTCBDb3JwMS4wLAYDVQQDDCVTU0wuY29tIEVWIFNTTCBJbnRl
cm1lZGlhdGUgQ0EgUlNBIFIzMB4XDTIwMDQwMTAwNTgzM1oXDTIxMDcxNjAwNTgz
M1owgb0xCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVUZXhhczEQMA4GA1UEBwwHSG91
c3RvbjERMA8GA1UECgwIU1NMIENvcnAxFjAUBgNVBAUTDU5WMjAwODE2MTQyNDMx
FDASBgNVBAMMC3d3dy5zc2wuY29tMR0wGwYDVQQPDBRQcml2YXRlIE9yZ2FuaXph
dGlvbjEXMBUGCysGAQQBgjc8AgECDAZOZXZhZGExEzARBgsrBgEEAYI3PAIBAxMC
-----END RSA PRIVATE KEY-----

     |client_cert |(x) |{noformat:nopanel=true}String{noformat} | PEM format certificate |  | -----BEGIN CERTIFICATE-----

MIIH/TCCBeWgAwIBAgIQaBYE3/M08XHYCnNVmcFBcjANBgkqhkiG9w0BAQsFADBy
MQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxEDAOBgNVBAcMB0hvdXN0b24x
ETAPBgNVBAoMCFNTTCBDb3JwMS4wLAYDVQQDDCVTU0wuY29tIEVWIFNTTCBJbnRl
cm1lZGlhdGUgQ0EgUlNBIFIzMB4XDTIwMDQwMTAwNTgzM1oXDTIxMDcxNjAwNTgz
M1owgb0xCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVUZXhhczEQMA4GA1UEBwwHSG91
c3RvbjERMA8GA1UECgwIU1NMIENvcnAxFjAUBgNVBAUTDU5WMjAwODE2MTQyNDMx
FDASBgNVBAMMC3d3dy5zc2wuY29tMR0wGwYDVQQPDBRQcml2YXRlIE9yZ2FuaXph
dGlvbjEXMBUGCysGAQQBgjc8AgECDAZOZXZhZGExEzARBgsrBgEEAYI3PAIBAxMC
-----END CERTIFICATE-----

    {anchor:RequestNotificationBodyModelAnchor}
    h3. RequestNotificationBody

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |requestId |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |requestTypeId |(x) |{noformat:nopanel=true}UUID{noformat} | Identifier of the type of process associated to the request. This identifier is given to the Integrator

during initial setup of the integration project. | | null
|status |(x) |{noformat:nopanel=true}RequestStatus{noformat} | | | null

    {anchor:RequestResourceModelAnchor}
    h3. RequestResource

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |id |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |filename |(x) |{noformat:nopanel=true}String{noformat} |  |  | audit_log.pdf
     |mimeType |(x) |{noformat:nopanel=true}String{noformat} |  |  | null
     |name |(x) |{noformat:nopanel=true}String{noformat} |  |  | Audit Log
     |type |(x) |{noformat:nopanel=true}String{noformat} | 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' | | BIOMETRY_VIDEO
  |family |(x) |{noformat:nopanel=true}String{noformat} | Values may be added overtime.
  List of values:

• 'IDENTIFICATION_ASSET'

• 'SIGNED_DOCUMENT'

• 'ATTACHMENT'

• 'PROOF' | | IDENTIFICATION_ASSET
  |subType |(x) |{noformat:nopanel=true}String{noformat} | Values may be added overtime.
  List of values:

• 'BEST_SELFIE'

• 'PROCESSED_FRONT_SIDE'

• 'PROCESSED_BACK_SIDE'

• 'SELFIE'

• 'FRONT_SIDE'

• 'BACK_SIDE'

• 'ID_PHOTO' | | FRONT_SIDE
  |metadata |(x) |{noformat:nopanel=true}ObjectNode{noformat} | | | null
  |resourceUrl |(x) |{noformat:nopanel=true}URI{noformat} | | | https://storage.onboarding.example/res/121323?ts=12386ddd
  |urlValidBefore |(x) |{noformat:nopanel=true}Date{noformat} | | | null
  |status |(x) |{noformat:nopanel=true}String{noformat} | Values may be added overtime.
  List of values:

• AVAILABLE -> Can be downloaded

• IN_TRANSFER -> The resource is still incomplete | | AVAILABLE

  Code Block
  {anchor:RequestStatusModelAnchor} h3. RequestStatus - `CREATED`: The request has been created, but its processing has to start yet.

• RUNNING: The request is being processed, it means that actions from users or systems still have to be completed.

• COMPLETED: Final status for a request completed successfully (according to specific request type
  it may have warnings or unsuccessful scenarios accepted by operational behavior).

• EXPIRED: Final status for a request that has not been completed before the expiration time.

• FAILED: Final status for a request whose processing has failed.

• USER_CANCELLED: Final status for a request that a user has explicitly cancelled (not applicable to all request types).

• OPERATOR_CANCELLED: Final status for a request that an operator has explicitly cancelled (not applicable to all request types).

  Code Block
  ||Name||Value||Description|| |CREATED |"CREATED" | |

|RUNNING |"RUNNING" | |
|COMPLETED |"COMPLETED" | |
|EXPIRED |"EXPIRED" | |
|FAILED |"FAILED" | |
|USER_CANCELLED |"USER_CANCELLED" | |
|OPERATOR_CANCELLED |"OPERATOR_CANCELLED" | |

    {anchor:RequestsGetModelAnchor}
    h3. RequestsGet

    

    
    ||Field Name||Required||Type||Description||Enum||Example||
     |id |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |organizationId |(x) |{noformat:nopanel=true}UUID{noformat} |  |  | null
     |status |(x) |{noformat:nopanel=true}RequestStatus{noformat} |  |  | null
     |referenceId |(x) |{noformat:nopanel=true}String{noformat} | Optional field. It maps an id that is relevant for the Integrator. The filed is not used internally.

More requests can have the same value. | | order-1234-0002
|requestTypeId |(x) |{noformat:nopanel=true}UUID{noformat} | Identifier of the type of process associated to the request. This identifier is given to the Integrator
during initial setup of the integration project. | | null
|createdAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null
|updatedAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null
|finalizedAt |(x) |{noformat:nopanel=true}Date{noformat} | | | null

How to visualize a YAML

1. Go to Swagger Editor

2. Then on “File” select “Import File”:

   Image Added

3. Select the file downloaded from the link above:
   your Swagger Editor will be immediately ready to use

Old versions