All URIs are relative to https://sandbox.finapi.io
Method | HTTP request | Description |
---|---|---|
CreateUser | Post /api/v1/users | Create a new user |
DeleteAuthorizedUser | Delete /api/v1/users | Delete the authorized user |
DeleteUnverifiedUser | Delete /api/v1/users/{userId} | Delete an unverified user |
EditAuthorizedUser | Patch /api/v1/users | Edit the authorized user |
ExecutePasswordChange | Post /api/v1/users/executePasswordChange | Execute password change |
GetAuthorizedUser | Get /api/v1/users | Get the authorized user |
GetVerificationStatus | Get /api/v1/users/verificationStatus | Get a user's verification status |
RequestPasswordChange | Post /api/v1/users/requestPasswordChange | Request password change |
VerifyUser | Post /api/v1/users/verify/{userId} | Verify a user |
User CreateUser(ctx).UserCreateParams(userCreateParams).XRequestId(xRequestId).Execute()
Create a new user
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
userCreateParams := *openapiclient.NewUserCreateParams() // UserCreateParams | User's details
xRequestId := "xRequestId_example" // string | 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. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.UsersApi.CreateUser(context.Background()).UserCreateParams(userCreateParams).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.CreateUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateUser`: User
fmt.Fprintf(os.Stdout, "Response from `UsersApi.CreateUser`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiCreateUserRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
userCreateParams | UserCreateParams | User's details | |
xRequestId | string | 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. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteAuthorizedUser(ctx).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
Delete the authorized user
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xHTTPMethodOverride := "xHTTPMethodOverride_example" // string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. (optional)
xRequestId := "xRequestId_example" // string | 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. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.UsersApi.DeleteAuthorizedUser(context.Background()).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.DeleteAuthorizedUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Other parameters are passed through a pointer to a apiDeleteAuthorizedUserRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
xHTTPMethodOverride | string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. | |
xRequestId | string | 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. |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteUnverifiedUser(ctx, userId).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
Delete an unverified user
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
userId := "userId_example" // string |
xHTTPMethodOverride := "xHTTPMethodOverride_example" // string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. (optional)
xRequestId := "xRequestId_example" // string | 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. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.UsersApi.DeleteUnverifiedUser(context.Background(), userId).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.DeleteUnverifiedUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
userId | string |
Other parameters are passed through a pointer to a apiDeleteUnverifiedUserRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
xHTTPMethodOverride | string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. | xRequestId | string | 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. |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
User EditAuthorizedUser(ctx).UserUpdateParams(userUpdateParams).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
Edit the authorized user
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
userUpdateParams := *openapiclient.NewUserUpdateParams() // UserUpdateParams | User's details
xHTTPMethodOverride := "xHTTPMethodOverride_example" // string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. (optional)
xRequestId := "xRequestId_example" // string | 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. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.UsersApi.EditAuthorizedUser(context.Background()).UserUpdateParams(userUpdateParams).XHTTPMethodOverride(xHTTPMethodOverride).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.EditAuthorizedUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `EditAuthorizedUser`: User
fmt.Fprintf(os.Stdout, "Response from `UsersApi.EditAuthorizedUser`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiEditAuthorizedUserRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
userUpdateParams | UserUpdateParams | User's details | |
xHTTPMethodOverride | string | Some HTTP clients do not support the HTTP methods PATCH or DELETE. If you are using such a client in your application, you can use a POST request instead with this header indicating the originally intended HTTP method. POST Requests having this header set will be treated either as PATCH or DELETE by the finAPI servers. | |
xRequestId | string | 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. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ExecutePasswordChange(ctx).ExecutePasswordChangeParams(executePasswordChangeParams).XRequestId(xRequestId).Execute()
Execute password change
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
executePasswordChangeParams := *openapiclient.NewExecutePasswordChangeParams("username", "password", "45a611d8-8a19-4a02-8726-a24b6a691ce9") // ExecutePasswordChangeParams |
xRequestId := "xRequestId_example" // string | 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. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.UsersApi.ExecutePasswordChange(context.Background()).ExecutePasswordChangeParams(executePasswordChangeParams).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.ExecutePasswordChange``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Other parameters are passed through a pointer to a apiExecutePasswordChangeRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
executePasswordChangeParams | ExecutePasswordChangeParams | ||
xRequestId | string | 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. |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
User GetAuthorizedUser(ctx).XRequestId(xRequestId).Execute()
Get the authorized user
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
xRequestId := "xRequestId_example" // string | 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. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.UsersApi.GetAuthorizedUser(context.Background()).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GetAuthorizedUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAuthorizedUser`: User
fmt.Fprintf(os.Stdout, "Response from `UsersApi.GetAuthorizedUser`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiGetAuthorizedUserRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
xRequestId | string | 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. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VerificationStatusResource GetVerificationStatus(ctx).UserId(userId).XRequestId(xRequestId).Execute()
Get a user's verification status
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
userId := "userId_example" // string | User's identifier
xRequestId := "xRequestId_example" // string | 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. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.UsersApi.GetVerificationStatus(context.Background()).UserId(userId).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.GetVerificationStatus``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetVerificationStatus`: VerificationStatusResource
fmt.Fprintf(os.Stdout, "Response from `UsersApi.GetVerificationStatus`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiGetVerificationStatusRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
userId | string | User's identifier | |
xRequestId | string | 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. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PasswordChangingResource RequestPasswordChange(ctx).RequestPasswordChangeParams(requestPasswordChangeParams).XRequestId(xRequestId).Execute()
Request password change
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
requestPasswordChangeParams := *openapiclient.NewRequestPasswordChangeParams("username") // RequestPasswordChangeParams |
xRequestId := "xRequestId_example" // string | 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. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.UsersApi.RequestPasswordChange(context.Background()).RequestPasswordChangeParams(requestPasswordChangeParams).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.RequestPasswordChange``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `RequestPasswordChange`: PasswordChangingResource
fmt.Fprintf(os.Stdout, "Response from `UsersApi.RequestPasswordChange`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiRequestPasswordChangeRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
requestPasswordChangeParams | RequestPasswordChangeParams | ||
xRequestId | string | 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. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VerifyUser(ctx, userId).XRequestId(xRequestId).Execute()
Verify a user
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
userId := "userId_example" // string | User's identifier
xRequestId := "xRequestId_example" // string | 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. (optional)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.UsersApi.VerifyUser(context.Background(), userId).XRequestId(xRequestId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `UsersApi.VerifyUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
userId | string | User's identifier |
Other parameters are passed through a pointer to a apiVerifyUserRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
xRequestId | string | 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. |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]