Get the status of a company's corporate application by external id

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId} \
  --header 'Api-Key: <api-key>'

import requests

url = "https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId}"

headers = {"Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};

fetch('https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId}', 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/applications/company/external/{externalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId}")

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

request = Net::HTTP::Get.new(url)
request["Api-Key"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ultimateBeneficialOwners": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applicationStatus": "approved",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "applicationExternalVerificationLink": {
        "url": "<string>",
        "params": {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "applicationCompletionLink": {
        "url": "<string>",
        "params": {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "applicationReason": "<string>"
    }
  ],
  "applicationStatus": "approved",
  "externalId": "<string>",
  "applicationExternalVerificationLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationCompletionLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationReason": "<string>"
}

GET

issuing

applications

company

external

{externalId}

Get the status of a company's corporate application by external id

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId} \
  --header 'Api-Key: <api-key>'

import requests

url = "https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId}"

headers = {"Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};

fetch('https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId}', 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/applications/company/external/{externalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.rain.xyz/v1/issuing/applications/company/external/{externalId}")

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

request = Net::HTTP::Get.new(url)
request["Api-Key"] = '<api-key>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ultimateBeneficialOwners": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "applicationStatus": "approved",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "applicationExternalVerificationLink": {
        "url": "<string>",
        "params": {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "applicationCompletionLink": {
        "url": "<string>",
        "params": {
          "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "applicationReason": "<string>"
    }
  ],
  "applicationStatus": "approved",
  "externalId": "<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

externalId

string

required

External id of the company whose application to get

Required string length: 1 - 255

Response

Successful operation

string<uuid>

required

The company application's id

ultimateBeneficialOwners

object[]

required

The company's ultimate beneficial owners

Show child attributes

applicationStatus

enum<string>

required

Available options:

approved,

pending,

needsInformation,

needsVerification,

manualReview,

denied,

locked,

canceled,

notStarted,

tosNotAccepted

externalId

string

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

Required string length: 1 - 255

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

Get the status of a company's corporate application by external id

Authorizations

Path Parameters

Response