Fetch detailed information about a specific user

GET /users/{id_or_external_id}

Fetch a user information created earlier POST /users API endpoint.

Path parameters

  • id_or_external_id string Required

    UUID of an existing diff from which to fetch diff details

Responses

  • 200

    User profiile retrieved

    Hide response attributes Show response attributes object
    • full_name string

      Mandatory for better user experience. User full name, if present, builds up user trust and displayed when interacting with a user

    • external_id string

      Optional Set up your own ID to match with your internal system for better monitoring.

    • ssn string

      Required for some API requests Set SSN when requested additional data collection, including credit report, tax information, etc.

    • country string

      Set a default country for a user to improve user experience and display banks from the country by default.

    • test boolean

      Set to false by default Define, if the test flow should be used for development purpose.

    • credentials array[object]

      Credentials of connected financial institutions.

      Hide credentials attributes Show credentials attributes array[object]
      • name string
      • code string
      • expire_at date
  • 404

    User not found

  • 500

    The request is not valid.

    Hide response attributes Show response attributes object
    • error_message string

      Human readable error message.

    • error string

      Error code & short status

GET /users/{id_or_external_id}
curl \
 -X GET https://link.goscore.me/finid-api/1.0/users/{id_or_external_id} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "full_name": "string",
  "external_id": "string",
  "ssn": "string",
  "country": "se",
  "test": true,
  "credentials": [
    {
      "name": "string",
      "code": "string",
      "expire_at": "string"
    }
  ]
}
Response examples (200)
{
  "full_name": "string",
  "external_id": "string",
  "ssn": "string",
  "country": "se",
  "test": true,
  "credentials": [
    {
      "name": "string",
      "code": "string",
      "expire_at": "string"
    }
  ]
}
Response examples (500)
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}
Response examples (500)
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}