Get users

Get users

curl --request GET \
  --url https://sandbox.killb.app/api/v2/users \
  --header 'Authorization: Bearer <token>'

{
  "users": [
    {
      "id": "4d23aa52-1b40-4584-a8ea-58aba6099c5c",
      "status": "ACTIVE",
      "customerId": "8ffce092-b97a-48bd-9efa-24c66ac7fe13",
      "type": "PERSON",
      "data": {
        "firstName": "John",
        "lastName": "Francisco",
        "dateOfBirth": "1992-01-01",
        "email": "[email protected]",
        "phone": "+576015555555",
        "address": {
          "street1": "68528 Dwight Court",
          "city": "Fiorenze",
          "state": "New York",
          "zipCode": "48245000",
          "countryCode": "CO",
          "street2": "Apt 488"
        },
        "document": {
          "type": "PASSPORT",
          "number": "GE04292393",
          "issuedCountryCode": "CO",
          "expeditionDate": "1992-01-01",
          "cic": "1111111111",
          "identificadorCiudadano": "<string>",
          "ocr": "1111111111",
          "numeroEmision": "<string>"
        },
        "middleName": "Carlos",
        "nationality": "CO",
        "citizenship": "CO",
        "employmentStatus": "EMPLOYEE",
        "employmentDescription": "Software Engineer",
        "employerName": "Google",
        "occupation": "Software Engineer",
        "investmentProfile": {
          "primarySourceOfFunds": "EMPLOYMENT",
          "primarySourceOfFundsDescription": "I work at Google",
          "totalAssets": "UPTO_10K",
          "usdValueOfFiat": "UPTO_10K",
          "monthlyDeposits": "UPTO_5",
          "monthlyWithdrawals": "UPTO_5",
          "monthlyInvestmentDeposit": "UPTO_1K",
          "monthlyInvestmentWithdrawal": "UPTO_1K",
          "usdValueOfCrypto": "UPTO_1K",
          "monthlyCryptoDeposits": "UPTO_5",
          "monthlyCryptoWithdrawals": "UPTO_5",
          "monthlyCryptoInvestmentDeposit": "UPTO_1K",
          "monthlyCryptoInvestmentWithdrawal": "UPTO_1K"
        },
        "kycProfile": {
          "fundsSendReceiveJurisdictions": [
            "<string>"
          ],
          "engageInActivities": "NONE"
        }
      },
      "complianceUrl": "https://kyc.example.com",
      "accessLevel": "L0",
      "note": "<string>",
      "active": true,
      "createdAt": "2024-02-06T00:03:30.791Z",
      "updatedAt": "2024-02-06T00:03:30.791Z",
      "externalId": "d00e4f43-2022-42f3-ba1c-dcf4c1dcd934"
    }
  ],
  "totalPage": 1
}

GET

api

users

Get users

curl --request GET \
  --url https://sandbox.killb.app/api/v2/users \
  --header 'Authorization: Bearer <token>'

{
  "users": [
    {
      "id": "4d23aa52-1b40-4584-a8ea-58aba6099c5c",
      "status": "ACTIVE",
      "customerId": "8ffce092-b97a-48bd-9efa-24c66ac7fe13",
      "type": "PERSON",
      "data": {
        "firstName": "John",
        "lastName": "Francisco",
        "dateOfBirth": "1992-01-01",
        "email": "[email protected]",
        "phone": "+576015555555",
        "address": {
          "street1": "68528 Dwight Court",
          "city": "Fiorenze",
          "state": "New York",
          "zipCode": "48245000",
          "countryCode": "CO",
          "street2": "Apt 488"
        },
        "document": {
          "type": "PASSPORT",
          "number": "GE04292393",
          "issuedCountryCode": "CO",
          "expeditionDate": "1992-01-01",
          "cic": "1111111111",
          "identificadorCiudadano": "<string>",
          "ocr": "1111111111",
          "numeroEmision": "<string>"
        },
        "middleName": "Carlos",
        "nationality": "CO",
        "citizenship": "CO",
        "employmentStatus": "EMPLOYEE",
        "employmentDescription": "Software Engineer",
        "employerName": "Google",
        "occupation": "Software Engineer",
        "investmentProfile": {
          "primarySourceOfFunds": "EMPLOYMENT",
          "primarySourceOfFundsDescription": "I work at Google",
          "totalAssets": "UPTO_10K",
          "usdValueOfFiat": "UPTO_10K",
          "monthlyDeposits": "UPTO_5",
          "monthlyWithdrawals": "UPTO_5",
          "monthlyInvestmentDeposit": "UPTO_1K",
          "monthlyInvestmentWithdrawal": "UPTO_1K",
          "usdValueOfCrypto": "UPTO_1K",
          "monthlyCryptoDeposits": "UPTO_5",
          "monthlyCryptoWithdrawals": "UPTO_5",
          "monthlyCryptoInvestmentDeposit": "UPTO_1K",
          "monthlyCryptoInvestmentWithdrawal": "UPTO_1K"
        },
        "kycProfile": {
          "fundsSendReceiveJurisdictions": [
            "<string>"
          ],
          "engageInActivities": "NONE"
        }
      },
      "complianceUrl": "https://kyc.example.com",
      "accessLevel": "L0",
      "note": "<string>",
      "active": true,
      "createdAt": "2024-02-06T00:03:30.791Z",
      "updatedAt": "2024-02-06T00:03:30.791Z",
      "externalId": "d00e4f43-2022-42f3-ba1c-dcf4c1dcd934"
    }
  ],
  "totalPage": 1
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit

number

page

number

string

firstName

string

middleName

string

dateOfBirth

string

externalId

string

A unique identifier used to identify your existing user.

companyName

string

tradeName

string

legalStructure

string

description

string

establishedOn

string

phone

string

mainOwnerUser

string

ownerUsers

string[]

naics

string

naicsDescription

string

customerId

string

type

enum<string>

required

Available options:

PERSON,

COMPANY

Example:

"PERSON"

Response

users

object[]

required

Show child attributes

users.id

string

required

Example:

"4d23aa52-1b40-4584-a8ea-58aba6099c5c"

users.status

enum<string>

required

Available options:

ACTIVE,

PENDING,

REJECTED

Example:

"ACTIVE"

users.customerId

string

required

Example:

"8ffce092-b97a-48bd-9efa-24c66ac7fe13"

users.type

enum<string>

required

Available options:

PERSON,

COMPANY

Example:

"PERSON"

users.data

PERSON · object

required

PERSON
COMPANY

Show child attributes

users.data.firstName

string

required

Example:

"John"

users.data.lastName

string

required

Example:

"Francisco"

users.data.dateOfBirth

string

required

Example:

"1992-01-01"

users.data.email

string

required

Example:

"[email protected]"

users.data.phone

string

required

Example:

"+576015555555"

users.data.address

object

required

Show child attributes

users.data.address.street1

string

required

Example:

"68528 Dwight Court"

users.data.address.city

string

required

Example:

"Fiorenze"

users.data.address.state

string

required

Example:

"New York"

users.data.address.zipCode

string

required

Example:

"48245000"

users.data.address.countryCode

string

required

Example:

"CO"

users.data.address.street2

string

Example:

"Apt 488"

users.data.document

object

required

Show child attributes

users.data.document.type

enum<string>

required

Available options:

PASSPORT,

DRIVER_LICENSE,

NUIP,

RFC,

SSN,

CURP,

CPF,

INE,

IFE,

DNI,

DUI,

NIT,

RUT,

CHINESE_ID,

BOLIVIAN_ID

Example:

"PASSPORT"

users.data.document.number

string<alphanumeric>

required

Example:

"GE04292393"

users.data.document.issuedCountryCode

string

required

Example:

"CO"

users.data.document.expeditionDate

string

Example:

"1992-01-01"

users.data.document.cic

string

Required if document type is INE

Example:

"1111111111"

users.data.document.identificadorCiudadano

string

Required if document type is INE

users.data.document.ocr

string

Required if document type is IFE

Example:

"1111111111"

users.data.document.numeroEmision

string

Required if document type is IFE

users.data.middleName

string

Example:

"Carlos"

users.data.nationality

string

Example:

"CO"

users.data.citizenship

string

Example:

"CO"

users.data.employmentStatus

enum<string>

Available options:

EMPLOYEE,

SELF_EMPLOYED,

RETIRED,

UNEMPLOYED,

OTHER

Example:

"EMPLOYEE"

users.data.employmentDescription

string

Example:

"Software Engineer"

users.data.employerName

string

Example:

"Google"

users.data.occupation

string

Example:

"Software Engineer"

users.data.investmentProfile

object

Show child attributes

users.data.investmentProfile.primarySourceOfFunds

enum<string>

required

Available options:

EMPLOYMENT,

SAVINGS,

WINNINGS,

MARITAL,

REAL_ESTATE,

TRUST,

INVESTMENT,

OTHER,

COMPANY,

COMPANY_CAPITAL,

LOAN,

PRIVATE_CAPITAL,

GRANT

Example:

"EMPLOYMENT"

users.data.investmentProfile.primarySourceOfFundsDescription

string

required

Example:

"I work at Google"

users.data.investmentProfile.totalAssets

enum<string>

required

Available options:

UPTO_10K,

TEN_TO_100K,

ONEHUNDREDK_TO_1M,

ONE_TO_10M,

TEN_TO_50M,

FIFTY_TO_250M,

MORE_THAN_250M

Example:

"UPTO_10K"

users.data.investmentProfile.usdValueOfFiat

enum<string>

required

Available options:

UPTO_10K,

TEN_TO_100K,

ONEHUNDREDK_TO_1M,

ONE_TO_10M,

TEN_TO_50M,

FIFTY_TO_250M,

MORE_THAN_250M

Example:

"UPTO_10K"

users.data.investmentProfile.monthlyDeposits

enum<string>

required

Available options:

UPTO_5,

FIVE_TO_10,

TEN_TO_25,

MORE_THAN_25

Example:

"UPTO_5"

users.data.investmentProfile.monthlyWithdrawals

enum<string>

required

Available options:

UPTO_5,

FIVE_TO_10,

TEN_TO_25,

MORE_THAN_25

Example:

"UPTO_5"

users.data.investmentProfile.monthlyInvestmentDeposit

enum<string>

required

Available options:

UPTO_1K,

ONE_TO_100K,

ONEHUNDREDK_TO_1M,

MILLION_TO_5M,

MORE_THAN_5M

Example:

"UPTO_1K"

users.data.investmentProfile.monthlyInvestmentWithdrawal

enum<string>

required

Available options:

UPTO_1K,

ONE_TO_100K,

ONEHUNDREDK_TO_1M,

MILLION_TO_5M,

MORE_THAN_5M

Example:

"UPTO_1K"

users.data.investmentProfile.usdValueOfCrypto

enum<string>

required

Available options:

UPTO_1K,

ONE_TO_100K,

ONEHUNDREDK_TO_1M,

MILLION_TO_5M,

MORE_THAN_5M

Example:

"UPTO_1K"

users.data.investmentProfile.monthlyCryptoDeposits

enum<string>

required

Available options:

UPTO_5,

FIVE_TO_10,

TEN_TO_25,

MORE_THAN_25

Example:

"UPTO_5"

users.data.investmentProfile.monthlyCryptoWithdrawals

enum<string>

required

Available options:

UPTO_5,

FIVE_TO_10,

TEN_TO_25,

MORE_THAN_25

Example:

"UPTO_5"

users.data.investmentProfile.monthlyCryptoInvestmentDeposit

enum<string>

required

Available options:

UPTO_1K,

ONE_TO_100K,

ONEHUNDREDK_TO_1M,

MILLION_TO_5M,

MORE_THAN_5M

Example:

"UPTO_1K"

users.data.investmentProfile.monthlyCryptoInvestmentWithdrawal

enum<string>

required

Available options:

UPTO_1K,

ONE_TO_100K,

ONEHUNDREDK_TO_1M,

MILLION_TO_5M,

MORE_THAN_5M

Example:

"UPTO_1K"

users.data.kycProfile

object

Show child attributes

users.data.kycProfile.fundsSendReceiveJurisdictions

string[]

required

users.data.kycProfile.engageInActivities

enum<string>[]

required

Available options:

NONE,

ADULT_ENTERTAINMENT,

DRUGS,

FIREARMS,

GAMBLING,

MARIJUANA,

TUMBLING

Example:

"NONE"

users.complianceUrl

string

required

Example:

"https://kyc.example.com"

users.accessLevel

enum<string>

required

Available options:

L0,

L1,

L2,

L3,

L4

Example:

"L0"

users.note

string

required

give you details about the compliance process

users.active

boolean

required

Example:

true

users.createdAt

string<date-time>

required

Example:

"2024-02-06T00:03:30.791Z"

users.updatedAt

string<date-time>

required

Example:

"2024-02-06T00:03:30.791Z"

users.externalId

string

A unique identifier used to identify your existing user.

Example:

"d00e4f43-2022-42f3-ba1c-dcf4c1dcd934"

totalPage

number

required

Example:

1

Update webhook config Create a user

⌘I

Introduction

Endpoints

Authorizations

Query Parameters

Response