Delete user

Remove user via the Junction API. Requires authentication with your team API key.

DELETE /v2/user/{user_id}

cURL

curl --request DELETE \
     --url {{BASE_URL}}/v2/user/{user_id} \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Accept: application/json'

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.user.delete({ userId: "<user_id>" });

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.user.delete("<user_id>")

import com.junction.api.Junction;
import com.junction.api.core.Environment;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.user().delete("<user_id>");

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

response, err := c.User.Delete(context.TODO(), &junction.DeleteUserRequest{
    UserId: "<user_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

200

{
  "success": true
}

{
  "detail": "<unknown>"
}

Deleting a user would also deregister all their provider connections immediately. Junction erases the user data after a 7-day grace period.

If you wish to undo a user deletion for any reason, you can undo the deletion through the Undo User Deletion API. Note that undoing would not restore any provider connections.

cURL

curl --request DELETE \
     --url {{BASE_URL}}/v2/user/{user_id} \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Accept: application/json'

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.user.delete({ userId: "<user_id>" });

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.user.delete("<user_id>")

import com.junction.api.Junction;
import com.junction.api.core.Environment;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.user().delete("<user_id>");

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

response, err := c.User.Delete(context.TODO(), &junction.DeleteUserRequest{
    UserId: "<user_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Path Parameters

user_id · string<uuid> · required

Response

200

application/json

Successful Response

success · boolean · required

Whether operation was successful or not