Create a new user profile and start a account aggregation

POST /users

Create a user profile to aggregate transactional data. The user profile defines how all insights are calculated, including transaction categorization, budget, and expenditure.

Body

The User prrofile creation request 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.

Responses

  • 201

    User successfully created

    Hide response attributes Show response attributes object
    • id string

      Unique id of your user

    • url string(uri)

      User flow URL. Use it to redirect user to an authorisation and consent collection flow, including bank accounuts aggrergation and to generate a credit report.
  • 422

    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
POST /users 
curl \
 -X POST https://link.goscore.me/finid-api/1.0/users \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"full_name":"string","external_id":"string","ssn":"string","country":"se","test":true}'
Request example 
{
  "full_name": "string",
  "external_id": "string",
  "ssn": "string",
  "country": "se",
  "test": true
}
Request examples 
{
  "full_name": "string",
  "external_id": "string",
  "ssn": "string",
  "country": "se",
  "test": true
}
Response examples (201) 
{
  "id": "3ef8f52f-9056-4113-840e-2f7183b90e06",
  "url": "https://example.com"
}
Response examples (201) 
{
  "id": "3ef8f52f-9056-4113-840e-2f7183b90e06",
  "url": "https://example.com"
}
Response examples (422) 
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}
Response examples (422) 
{
  "error_message": "Invalid requeet",
  "error": "ER-001"
}