Create Organization
curl --request POST \
--url https://api.baselayer.com/organizations \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"domain_name": "<string>",
"external_id": "<string>",
"contact": {
"name": "<string>",
"email": "jsmith@example.com"
}
}
'import requests
url = "https://api.baselayer.com/organizations"
payload = {
"name": "<string>",
"domain_name": "<string>",
"external_id": "<string>",
"contact": {
"name": "<string>",
"email": "jsmith@example.com"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
domain_name: '<string>',
external_id: '<string>',
contact: {name: '<string>', email: 'jsmith@example.com'}
})
};
fetch('https://api.baselayer.com/organizations', 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.baselayer.com/organizations",
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([
'name' => '<string>',
'domain_name' => '<string>',
'external_id' => '<string>',
'contact' => [
'name' => '<string>',
'email' => 'jsmith@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.baselayer.com/organizations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domain_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.baselayer.com/organizations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domain_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domain_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "a3d9af02-e679-4c12-a9b2-220b6eb78e2d",
"name": "The Avengers",
"domain_name": "avengers.com",
"type": "neobank",
"external_id": "b2e3a6ff-2734-47ed-ba87-54647e3550bd",
"webhooks_version": "2.0",
"federation": {
"id": "6d54d5fe-2fcd-4b83-891b-32e9e99656d6",
"name": "Stan Lee"
},
"applications": {
"enabled": true,
"external_id": null,
"id": "865a6f00-b7d7-4451-a787-6b89ac935f92",
"name": "Avengers - Sandbox",
"type": "sandbox"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Organizations
Create Organization
POST
/
organizations
Create Organization
curl --request POST \
--url https://api.baselayer.com/organizations \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"domain_name": "<string>",
"external_id": "<string>",
"contact": {
"name": "<string>",
"email": "jsmith@example.com"
}
}
'import requests
url = "https://api.baselayer.com/organizations"
payload = {
"name": "<string>",
"domain_name": "<string>",
"external_id": "<string>",
"contact": {
"name": "<string>",
"email": "jsmith@example.com"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
domain_name: '<string>',
external_id: '<string>',
contact: {name: '<string>', email: 'jsmith@example.com'}
})
};
fetch('https://api.baselayer.com/organizations', 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.baselayer.com/organizations",
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([
'name' => '<string>',
'domain_name' => '<string>',
'external_id' => '<string>',
'contact' => [
'name' => '<string>',
'email' => 'jsmith@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.baselayer.com/organizations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domain_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.baselayer.com/organizations")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domain_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domain_name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"contact\": {\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "a3d9af02-e679-4c12-a9b2-220b6eb78e2d",
"name": "The Avengers",
"domain_name": "avengers.com",
"type": "neobank",
"external_id": "b2e3a6ff-2734-47ed-ba87-54647e3550bd",
"webhooks_version": "2.0",
"federation": {
"id": "6d54d5fe-2fcd-4b83-891b-32e9e99656d6",
"name": "Stan Lee"
},
"applications": {
"enabled": true,
"external_id": null,
"id": "865a6f00-b7d7-4451-a787-6b89ac935f92",
"name": "Avengers - Sandbox",
"type": "sandbox"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
Required string length:
3 - 100Available options:
neobank, community_bank, credit_union, regional_bank, national_bank, fintech, smb_lender, merchant_cash_advanced, processor, infrastructure, other Maximum string length:
100Required string length:
3 - 128Show child attributes
Show child attributes
Response
Successful Response
Represents an organization response.
The unique identifier of the Organization.
Example:
"a3d9af02-e679-4c12-a9b2-220b6eb78e2d"
The name of the Organization.
Example:
"The Avengers"
The domain name of the Organization.
Example:
"avengers.com"
The type of the organization.
Available options:
neobank, community_bank, credit_union, regional_bank, national_bank, fintech, smb_lender, merchant_cash_advanced, processor, infrastructure, other An external identifier for referencing the Organization using the ID from a namespace in an external system.
Example:
"b2e3a6ff-2734-47ed-ba87-54647e3550bd"
The version of Baselayer Webhooks the Organization utilizies.
Available options:
0.8, 1.0, 2.0, 2.0 Example:
"2.0"
Represents a federation response.
Show child attributes
Show child attributes
Example:
{
"id": "6d54d5fe-2fcd-4b83-891b-32e9e99656d6",
"name": "Stan Lee"
}
The Applications belonging to the Organization.
Show child attributes
Show child attributes
Examples:
{
"enabled": true,
"external_id": null,
"id": "865a6f00-b7d7-4451-a787-6b89ac935f92",
"name": "Avengers - Sandbox",
"type": "sandbox"
}
{
"enabled": false,
"external_id": null,
"id": "aee180c8-ad54-474d-8046-87fd2ec176c6",
"name": "Avengers - Production",
"type": "production"
}