Update a customer

cURL

curl --request PUT \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/customers/<uuid> \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "device": {
    "ip_address": "192.168.1.1"
  },
  "status": "pending"
}'

import Straddle from '@straddlecom/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const customerV1 = await client.customers.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
    device: { ip_address: '192.168.1.1' },
    email: '[email protected]',
    name: 'name',
    phone: '+46991022',
    status: 'pending',
  });

  console.log(customerV1.data);
}

main();

import os
from straddle import Straddle

client = Straddle(
    api_key=os.environ.get("STRADDLE_API_KEY"),  # This is the default and can be omitted
)
customer_v1 = client.customers.update(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    device={
        "ip_address": "192.168.1.1"
    },
    email="[email protected]",
    name="name",
    phone="+46991022",
    status="pending",
)
print(customer_v1.data)

require "straddle"

straddle = Straddle::Client.new(
  api_key: ENV["STRADDLE_API_KEY"], # This is the default and can be omitted
  environment: "production" # defaults to "sandbox"
)

customer_v1 = straddle.customers.update(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  device: {ip_address: "192.168.1.1"},
  email: "[email protected]",
  name: "name",
  phone: "+46991022",
  status: :pending
)

puts(customer_v1)

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Ron Swanson",
    "email": "[email protected]",
    "phone": "+12128675309",
    "status": "verified",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "address": {
      "address1": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345",
      "address2": "Apt 1"
    },
    "compliance_profile": {
      "dob": "****-**-**",
      "ssn": "***-**-****"
    },
    "device": {
      "ip_address": "192.168.1.1"
    },
    "metadata": {},
    "config": {}
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

PUT

customers

{id}

cURL

curl --request PUT \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.com/v1/customers/<uuid> \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "device": {
    "ip_address": "192.168.1.1"
  },
  "status": "pending"
}'

import Straddle from '@straddlecom/straddle';

const client = new Straddle({
  apiKey: process.env['STRADDLE_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const customerV1 = await client.customers.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
    device: { ip_address: '192.168.1.1' },
    email: '[email protected]',
    name: 'name',
    phone: '+46991022',
    status: 'pending',
  });

  console.log(customerV1.data);
}

main();

import os
from straddle import Straddle

client = Straddle(
    api_key=os.environ.get("STRADDLE_API_KEY"),  # This is the default and can be omitted
)
customer_v1 = client.customers.update(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    device={
        "ip_address": "192.168.1.1"
    },
    email="[email protected]",
    name="name",
    phone="+46991022",
    status="pending",
)
print(customer_v1.data)

require "straddle"

straddle = Straddle::Client.new(
  api_key: ENV["STRADDLE_API_KEY"], # This is the default and can be omitted
  environment: "production" # defaults to "sandbox"
)

customer_v1 = straddle.customers.update(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  device: {ip_address: "192.168.1.1"},
  email: "[email protected]",
  name: "name",
  phone: "+46991022",
  status: :pending
)

puts(customer_v1)

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Ron Swanson",
    "email": "[email protected]",
    "phone": "+12128675309",
    "status": "verified",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "address": {
      "address1": "123 Main St",
      "city": "Anytown",
      "state": "CA",
      "zip": "12345",
      "address2": "Apt 1"
    },
    "compliance_profile": {
      "dob": "****-**-**",
      "ssn": "***-**-****"
    },
    "device": {
      "ip_address": "192.168.1.1"
    },
    "metadata": {},
    "config": {}
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "error": {
    "status": 123,
    "type": "<string>",
    "title": "<string>",
    "detail": "<string>",
    "items": [
      {
        "detail": "<string>",
        "reference": "<string>"
      }
    ]
  }
}

Updating more than two fields (not including metadata) within a 24 hour period will trigger a new identity score.

Authorizations

Authorization

string

header

required

Use your Straddle API Key in the Authorization header as Bearer to authorize API requests.

Headers

Straddle-Account-Id

string<uuid>

For use by platforms to specify an account id and set scope of a request.

Request-Id

string

Optional client generated identifier to trace and debug a request.

Correlation-Id

string

Optional client generated identifier to trace and debug a series of requests.

Idempotency-Key

string

Optional client generated value to use for idempotent requests.

Required string length: 10 - 40

Path Parameters

string<uuid>

required

Body

name

string

required

The customer's full name or business name.

string<email>

required

The customer's email address.

phone

string

required

The customer's phone number in E.164 format.

Pattern: ^\+[1-9]\d{1,14}$

device

object

required

Show child attributes

status

enum<string>

default:verified

required

Available options:

pending,

review,

verified,

inactive,

rejected

address

object | null

An object containing the customer's address. This is optional, but if provided, all required fields must be present.

Show child attributes

compliance_profile

Individual Compliance Profile · object

Individual PII data required to trigger Patriot Act compliant KYC verification.

Individual Compliance Profile
Business Compliance Profile

Show child attributes

external_id

string | null

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

metadata

object | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.

Show child attributes

Fundamentals

SDKs

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Payments

Embed

Authorizations

Headers

Path Parameters

Body

Response