Identity Verification

POST /user/{fin}/identity-verification

Verify the identity of a user with DigitalID.

Path parameters

fin string Required

application/json

Body Required

digitalIdCode string Required

Responses

200
Hide response attributes Show response attributes object
- address string Required
- birthdate string(date) Required
- familyName string Required
- givenName string Required
- middleName string | null
- name string Required

POST /user/{fin}/identity-verification

curl \
 -X POST http://api.example.com/user/{fin}/identity-verification \
 -H "Content-Type: application/json" \
 -d '{"digitalIdCode":"string"}'

Request example

{
  "digitalIdCode": "string"
}

Request examples

{
  "digitalIdCode": "string"
}

Response examples (200)

{
  "address": "string",
  "birthdate": "2023-05-04",
  "familyName": "string",
  "givenName": "string",
  "middleName": "string",
  "name": "string"
}

Response examples (200)

{
  "address": "string",
  "birthdate": "2025-05-04",
  "familyName": "string",
  "givenName": "string",
  "middleName": "string",
  "name": "string"
}