Create a new user. Must pass your global (i.e. client) access_token.
This service returns the user’s password as plain text.
The automatic update of the user’s bank connections is disabled by default for any new user. User identifiers are regarded case-insensitive by finAPI.
Please note that finAPI generally has a restricted set of allowed characters for input fields. You can find the allowed characters here. If a field does not explicitly specify a set of allowed characters, then these are the characters that are allowed for the field. Some fields may specify a different set of characters, in which case this will be documented for the field (like for the ‘id’ field in this service).
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
With any API call, you can pass a request ID. The request ID can be an arbitrary string with up to 255 characters. Passing a longer string will result in an error. If you don't pass a request ID for a call, finAPI will generate a random ID internally. The request ID is always returned back in the response of a service, as a header with name 'X-Request-Id'. We highly recommend to always pass a (preferably unique) request ID, and include it into your client application logs whenever you make a request or receive a response (especially in the case of an error response). finAPI is also logging request IDs on its end. Having a request ID can help the finAPI support team to work more efficiently and solve tickets faster.
Successful response
The response is of type any
.