Update a company

curl --request PATCH \
  --url https://api-dev.rain.xyz/v1/issuing/companies/{companyId} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>",
  "name": "<string>"
}
'

import requests

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

payload = {
    "externalId": "<string>",
    "name": "<string>"
}
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({externalId: '<string>', name: '<string>'})
};

fetch('https://api-dev.rain.xyz/v1/issuing/companies/{companyId}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'externalId' => '<string>',
    'name' => '<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}"

	payload := strings.NewReader("{\n  \"externalId\": \"<string>\",\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api-dev.rain.xyz/v1/issuing/companies/{companyId}")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"<string>\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"<string>\",\n  \"name\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "countryCode": "<string>",
    "line2": "<string>",
    "country": "<string>"
  },
  "applicationStatus": "approved",
  "externalId": "<string>",
  "sourceKey": "<string>",
  "ultimateBeneficialOwners": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applicationStatus": "approved",
      "applicationExternalVerificationLink": {
        "url": "<string>",
        "params": {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "applicationCompletionLink": {
        "url": "<string>",
        "params": {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "applicationReason": "<string>"
    }
  ],
  "applicationExternalVerificationLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationCompletionLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationReason": "<string>"
}

PATCH

issuing

companies

{companyId}

Update a company

curl --request PATCH \
  --url https://api-dev.rain.xyz/v1/issuing/companies/{companyId} \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>",
  "name": "<string>"
}
'

import requests

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

payload = {
    "externalId": "<string>",
    "name": "<string>"
}
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({externalId: '<string>', name: '<string>'})
};

fetch('https://api-dev.rain.xyz/v1/issuing/companies/{companyId}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'externalId' => '<string>',
    'name' => '<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}"

	payload := strings.NewReader("{\n  \"externalId\": \"<string>\",\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api-dev.rain.xyz/v1/issuing/companies/{companyId}")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalId\": \"<string>\",\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalId\": \"<string>\",\n  \"name\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "countryCode": "<string>",
    "line2": "<string>",
    "country": "<string>"
  },
  "applicationStatus": "approved",
  "externalId": "<string>",
  "sourceKey": "<string>",
  "ultimateBeneficialOwners": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applicationStatus": "approved",
      "applicationExternalVerificationLink": {
        "url": "<string>",
        "params": {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "applicationCompletionLink": {
        "url": "<string>",
        "params": {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "applicationReason": "<string>"
    }
  ],
  "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 update

Body

application/json

The updates to apply to the company

externalId

string

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

Required string length: 1 - 255

name

string

The company's name on the Rain platform

address

object

The company's physical address

Show child attributes

Response

Successful operation

string<uuid>

required

The company's unique identifier

name

string

required

The company's name on the Rain platform

address

object

required

The company's physical address

Show child attributes

applicationStatus

enum<string>

required

Available options:

approved,

pending,

needsInformation,

needsVerification,

manualReview,

denied,

locked,

canceled

externalId

string

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

Required string length: 1 - 255

sourceKey

string

The source key associated with the company's team

Required string length: 1 - 24

ultimateBeneficialOwners

object[]

The company's ultimate beneficial owners

Show child attributes

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

Update a company

Authorizations

Path Parameters

Body

Response