Step 1: Authenticate to X - Twitter

Retrieving your X - Twitter credentials

To perform an authentication for Twitter, a user need its X - TWITTER username or phone number or mail and password.

Authentication

Make a POST request to this Unipile API endpoint or use the appropriate SDK Method.

const response = await client.account.connectTwitter({
  username: "unipile",
  password: "********"
})

todo

curl --request POST \
     --url https://{YOUR_DSN}/api/v1/accounts \
     --header 'X-API-KEY: {YOUR_ACCESS_TOKEN}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "provider": "TWITTER",
  "username": "unipile",
  "password": "********"
}
'

Step 2 : Handle 2FA checkpoint

If an Twitter account has the two-factor authentication activated, you will encounter a checkpoint through a 202 status. Here’s an example of a checkpoint response.

{
  "object": "Checkpoint",
  "account_id": "098dez89d",
  "checkpoint": {
    "type": "2FA"
  }
}

In this case, a new Authentication Intent starts. This intent last 5 minutes and checkpoints must be solved in this time frame.

Step 3 : Solve 2FA checkpoint

To solve the 2FA checkpoint, make a POST request to the Unipile API using the Solve checkpoint endpoint or use an SDK Method by giving the account_id returned by the first request

const response = await client.account.solveCodeCheckpoint({
  provider: "TWITTER",
  account_id: "098dez89d",
  code: "******",
});

todo

curl --request POST \
     --url https://{YOUR_DSN}/api/v1/accounts/checkpoint \
     --header 'X-API-KEY: {YOUR_ACCESS_TOKEN}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "provider": "TWITTER",
  "account_id": "098dez89d",
  "code": "******"
}
'

The response of this request will indicate if the account is successfully connected.

Step 4 : Handle Intent Timeout

If the user takes more than 5 minutes to solve the checkpoint, the account will not be connected. Any subsequent request to solve a checkpoint outside a 5 minutes time frame will first respond a 408 - Request Timeout, then a 400 - Bad Request as the Authentication Intent will self destroy.