Create a user in a company

curl --request POST \
  --url https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "birthDate": "2023-12-25",
  "walletAddress": "<string>",
  "solanaAddress": "<string>",
  "phoneCountryCode": "<string>",
  "phoneNumber": "<string>",
  "externalId": "<string>"
}
'

import requests

url = "https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "birthDate": "2023-12-25",
    "walletAddress": "<string>",
    "solanaAddress": "<string>",
    "phoneCountryCode": "<string>",
    "phoneNumber": "<string>",
    "externalId": "<string>"
}
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: '<string>',
    birthDate: '2023-12-25',
    walletAddress: '<string>',
    solanaAddress: '<string>',
    phoneCountryCode: '<string>',
    phoneNumber: '<string>',
    externalId: '<string>'
  })
};

fetch('https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '<string>',
    'birthDate' => '2023-12-25',
    'walletAddress' => '<string>',
    'solanaAddress' => '<string>',
    'phoneCountryCode' => '<string>',
    'phoneNumber' => '<string>',
    'externalId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"birthDate\": \"2023-12-25\",\n  \"walletAddress\": \"<string>\",\n  \"solanaAddress\": \"<string>\",\n  \"phoneCountryCode\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"externalId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"birthDate\": \"2023-12-25\",\n  \"walletAddress\": \"<string>\",\n  \"solanaAddress\": \"<string>\",\n  \"phoneCountryCode\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"externalId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"birthDate\": \"2023-12-25\",\n  \"walletAddress\": \"<string>\",\n  \"solanaAddress\": \"<string>\",\n  \"phoneCountryCode\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"externalId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "isActive": true,
  "applicationStatus": "approved",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "<string>",
  "sourceKey": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "countryCode": "<string>",
    "line2": "<string>",
    "country": "<string>"
  },
  "phoneCountryCode": "1",
  "phoneNumber": "5555555555",
  "walletAddress": "<string>",
  "solanaAddress": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "applicationExternalVerificationLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationCompletionLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationReason": "<string>"
}

POST

issuing

companies

{companyId}

users

Create a user in a company

curl --request POST \
  --url https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "birthDate": "2023-12-25",
  "walletAddress": "<string>",
  "solanaAddress": "<string>",
  "phoneCountryCode": "<string>",
  "phoneNumber": "<string>",
  "externalId": "<string>"
}
'

import requests

url = "https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "birthDate": "2023-12-25",
    "walletAddress": "<string>",
    "solanaAddress": "<string>",
    "phoneCountryCode": "<string>",
    "phoneNumber": "<string>",
    "externalId": "<string>"
}
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    email: '<string>',
    birthDate: '2023-12-25',
    walletAddress: '<string>',
    solanaAddress: '<string>',
    phoneCountryCode: '<string>',
    phoneNumber: '<string>',
    externalId: '<string>'
  })
};

fetch('https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '<string>',
    'birthDate' => '2023-12-25',
    'walletAddress' => '<string>',
    'solanaAddress' => '<string>',
    'phoneCountryCode' => '<string>',
    'phoneNumber' => '<string>',
    'externalId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"birthDate\": \"2023-12-25\",\n  \"walletAddress\": \"<string>\",\n  \"solanaAddress\": \"<string>\",\n  \"phoneCountryCode\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"externalId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"birthDate\": \"2023-12-25\",\n  \"walletAddress\": \"<string>\",\n  \"solanaAddress\": \"<string>\",\n  \"phoneCountryCode\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"externalId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-dev.rain.xyz/v1/issuing/companies/{companyId}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"birthDate\": \"2023-12-25\",\n  \"walletAddress\": \"<string>\",\n  \"solanaAddress\": \"<string>\",\n  \"phoneCountryCode\": \"<string>\",\n  \"phoneNumber\": \"<string>\",\n  \"externalId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "isActive": true,
  "applicationStatus": "approved",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "<string>",
  "sourceKey": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "countryCode": "<string>",
    "line2": "<string>",
    "country": "<string>"
  },
  "phoneCountryCode": "1",
  "phoneNumber": "5555555555",
  "walletAddress": "<string>",
  "solanaAddress": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "applicationExternalVerificationLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationCompletionLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationReason": "<string>"
}

Authorizations

Api-Key

string

header

required

Path Parameters

companyId

string<uuid>

required

Id of the company to create a user for

Body

application/json

The user to create

firstName

string

required

The user's first name

Maximum string length: 50

lastName

string

required

The user's last name

Maximum string length: 50

string

required

The user's email address

birthDate

string<date>

The user's birth date

walletAddress

string

This user's wallet address

Pattern: ^0x[0-9a-fA-F]{40}$

solanaAddress

string

This user's solana address

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

address

object

The user's physical address

Show child attributes

phoneCountryCode

string

The user's phone country code

phoneNumber

string

The user's phone number

externalId

string

An optional tenant-defined identifier for this user. Must be unique within the tenant.

Required string length: 1 - 255

Response

Successful operation

string<uuid>

required

The user's unique identifier

firstName

string

required

The user's first name

Maximum string length: 50

lastName

string

required

The user's last name

Maximum string length: 50

string

required

The user's email address

isActive

boolean

required

Whether the user is active

applicationStatus

enum<string>

required

Available options:

approved,

pending,

needsInformation,

needsVerification,

manualReview,

denied,

locked,

canceled

companyId

string<uuid>

The id of the company that the user belongs to, if any

externalId

string

An optional tenant-defined identifier for this user. Must be unique within the tenant.

Required string length: 1 - 255

sourceKey

string

The source key associated with the user's team

Required string length: 1 - 24

address

object

The user's physical address

Show child attributes

phoneCountryCode

string

The user's phone country code

Required string length: 1 - 3

Pattern: ^[0-9]+$

Example:

"1"

phoneNumber

string

The user's phone number

Required string length: 1 - 15

Pattern: ^[0-9]+$

Example:

"5555555555"

walletAddress

string

The user's EVM wallet address

solanaAddress

string

The user's Solana wallet address

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

createdAt

string<date-time>

When the user was created

updatedAt

string<date-time>

When the user was last updated

applicationExternalVerificationLink

object

deprecated

The link to the external verification page for the application

Show child attributes

applicationCompletionLink

object

The link to the completion page for the application

Show child attributes

applicationReason

string

The reason for the application status

Overview

Compliance

Cards

Payments

Webhooks

Webhook Events

Create a user in a company

Authorizations

Path Parameters

Body

Response