Create Payment Method

curl --request POST \
  --url http://api.gu1.ai/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityType": "<string>",
  "entityData": {
    "paymentMethod": {
      "type": "<string>",
      "last4": "<string>",
      "brand": "<string>",
      "expiryMonth": "<string>",
      "expiryYear": "<string>",
      "holderName": "<string>",
      "issuerCountry": "<string>",
      "bin": "<string>",
      "fingerprint": "<string>",
      "funding": "<string>",
      "accountNumber": "<string>",
      "accountType": "<string>",
      "bank": "<string>",
      "currency": "<string>",
      "routingNumber": "<string>",
      "provider": "<string>",
      "email": "<string>",
      "address": "<string>",
      "network": "<string>",
      "pixKey": "<string>",
      "pixKeyType": "<string>"
    }
  },
  "relationships": [
    {
      "targetEntityId": "<string>",
      "relationshipType": "<string>",
      "strength": 123,
      "metadata": {}
    }
  ],
  "metadata": {}
}
'

import requests

url = "http://api.gu1.ai/entities"

payload = {
    "entityType": "<string>",
    "entityData": { "paymentMethod": {
            "type": "<string>",
            "last4": "<string>",
            "brand": "<string>",
            "expiryMonth": "<string>",
            "expiryYear": "<string>",
            "holderName": "<string>",
            "issuerCountry": "<string>",
            "bin": "<string>",
            "fingerprint": "<string>",
            "funding": "<string>",
            "accountNumber": "<string>",
            "accountType": "<string>",
            "bank": "<string>",
            "currency": "<string>",
            "routingNumber": "<string>",
            "provider": "<string>",
            "email": "<string>",
            "address": "<string>",
            "network": "<string>",
            "pixKey": "<string>",
            "pixKeyType": "<string>"
        } },
    "relationships": [
        {
            "targetEntityId": "<string>",
            "relationshipType": "<string>",
            "strength": 123,
            "metadata": {}
        }
    ],
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityType: '<string>',
    entityData: {
      paymentMethod: {
        type: '<string>',
        last4: '<string>',
        brand: '<string>',
        expiryMonth: '<string>',
        expiryYear: '<string>',
        holderName: '<string>',
        issuerCountry: '<string>',
        bin: '<string>',
        fingerprint: '<string>',
        funding: '<string>',
        accountNumber: '<string>',
        accountType: '<string>',
        bank: '<string>',
        currency: '<string>',
        routingNumber: '<string>',
        provider: '<string>',
        email: '<string>',
        address: '<string>',
        network: '<string>',
        pixKey: '<string>',
        pixKeyType: '<string>'
      }
    },
    relationships: [
      {
        targetEntityId: '<string>',
        relationshipType: '<string>',
        strength: 123,
        metadata: {}
      }
    ],
    metadata: {}
  })
};

fetch('http://api.gu1.ai/entities', 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 => "http://api.gu1.ai/entities",
  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([
    'entityType' => '<string>',
    'entityData' => [
        'paymentMethod' => [
                'type' => '<string>',
                'last4' => '<string>',
                'brand' => '<string>',
                'expiryMonth' => '<string>',
                'expiryYear' => '<string>',
                'holderName' => '<string>',
                'issuerCountry' => '<string>',
                'bin' => '<string>',
                'fingerprint' => '<string>',
                'funding' => '<string>',
                'accountNumber' => '<string>',
                'accountType' => '<string>',
                'bank' => '<string>',
                'currency' => '<string>',
                'routingNumber' => '<string>',
                'provider' => '<string>',
                'email' => '<string>',
                'address' => '<string>',
                'network' => '<string>',
                'pixKey' => '<string>',
                'pixKeyType' => '<string>'
        ]
    ],
    'relationships' => [
        [
                'targetEntityId' => '<string>',
                'relationshipType' => '<string>',
                'strength' => 123,
                'metadata' => [
                                
                ]
        ]
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "http://api.gu1.ai/entities"

	payload := strings.NewReader("{\n  \"entityType\": \"<string>\",\n  \"entityData\": {\n    \"paymentMethod\": {\n      \"type\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"brand\": \"<string>\",\n      \"expiryMonth\": \"<string>\",\n      \"expiryYear\": \"<string>\",\n      \"holderName\": \"<string>\",\n      \"issuerCountry\": \"<string>\",\n      \"bin\": \"<string>\",\n      \"fingerprint\": \"<string>\",\n      \"funding\": \"<string>\",\n      \"accountNumber\": \"<string>\",\n      \"accountType\": \"<string>\",\n      \"bank\": \"<string>\",\n      \"currency\": \"<string>\",\n      \"routingNumber\": \"<string>\",\n      \"provider\": \"<string>\",\n      \"email\": \"<string>\",\n      \"address\": \"<string>\",\n      \"network\": \"<string>\",\n      \"pixKey\": \"<string>\",\n      \"pixKeyType\": \"<string>\"\n    }\n  },\n  \"relationships\": [\n    {\n      \"targetEntityId\": \"<string>\",\n      \"relationshipType\": \"<string>\",\n      \"strength\": 123,\n      \"metadata\": {}\n    }\n  ],\n  \"metadata\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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("http://api.gu1.ai/entities")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entityType\": \"<string>\",\n  \"entityData\": {\n    \"paymentMethod\": {\n      \"type\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"brand\": \"<string>\",\n      \"expiryMonth\": \"<string>\",\n      \"expiryYear\": \"<string>\",\n      \"holderName\": \"<string>\",\n      \"issuerCountry\": \"<string>\",\n      \"bin\": \"<string>\",\n      \"fingerprint\": \"<string>\",\n      \"funding\": \"<string>\",\n      \"accountNumber\": \"<string>\",\n      \"accountType\": \"<string>\",\n      \"bank\": \"<string>\",\n      \"currency\": \"<string>\",\n      \"routingNumber\": \"<string>\",\n      \"provider\": \"<string>\",\n      \"email\": \"<string>\",\n      \"address\": \"<string>\",\n      \"network\": \"<string>\",\n      \"pixKey\": \"<string>\",\n      \"pixKeyType\": \"<string>\"\n    }\n  },\n  \"relationships\": [\n    {\n      \"targetEntityId\": \"<string>\",\n      \"relationshipType\": \"<string>\",\n      \"strength\": 123,\n      \"metadata\": {}\n    }\n  ],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.gu1.ai/entities")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entityType\": \"<string>\",\n  \"entityData\": {\n    \"paymentMethod\": {\n      \"type\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"brand\": \"<string>\",\n      \"expiryMonth\": \"<string>\",\n      \"expiryYear\": \"<string>\",\n      \"holderName\": \"<string>\",\n      \"issuerCountry\": \"<string>\",\n      \"bin\": \"<string>\",\n      \"fingerprint\": \"<string>\",\n      \"funding\": \"<string>\",\n      \"accountNumber\": \"<string>\",\n      \"accountType\": \"<string>\",\n      \"bank\": \"<string>\",\n      \"currency\": \"<string>\",\n      \"routingNumber\": \"<string>\",\n      \"provider\": \"<string>\",\n      \"email\": \"<string>\",\n      \"address\": \"<string>\",\n      \"network\": \"<string>\",\n      \"pixKey\": \"<string>\",\n      \"pixKeyType\": \"<string>\"\n    }\n  },\n  \"relationships\": [\n    {\n      \"targetEntityId\": \"<string>\",\n      \"relationshipType\": \"<string>\",\n      \"strength\": 123,\n      \"metadata\": {}\n    }\n  ],\n  \"metadata\": {}\n}"

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

{
  "success": true,
  "id": "<string>",
  "entityType": "<string>",
  "entityData": {},
  "relationships": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

POST

entities

Create Payment Method

curl --request POST \
  --url http://api.gu1.ai/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityType": "<string>",
  "entityData": {
    "paymentMethod": {
      "type": "<string>",
      "last4": "<string>",
      "brand": "<string>",
      "expiryMonth": "<string>",
      "expiryYear": "<string>",
      "holderName": "<string>",
      "issuerCountry": "<string>",
      "bin": "<string>",
      "fingerprint": "<string>",
      "funding": "<string>",
      "accountNumber": "<string>",
      "accountType": "<string>",
      "bank": "<string>",
      "currency": "<string>",
      "routingNumber": "<string>",
      "provider": "<string>",
      "email": "<string>",
      "address": "<string>",
      "network": "<string>",
      "pixKey": "<string>",
      "pixKeyType": "<string>"
    }
  },
  "relationships": [
    {
      "targetEntityId": "<string>",
      "relationshipType": "<string>",
      "strength": 123,
      "metadata": {}
    }
  ],
  "metadata": {}
}
'

import requests

url = "http://api.gu1.ai/entities"

payload = {
    "entityType": "<string>",
    "entityData": { "paymentMethod": {
            "type": "<string>",
            "last4": "<string>",
            "brand": "<string>",
            "expiryMonth": "<string>",
            "expiryYear": "<string>",
            "holderName": "<string>",
            "issuerCountry": "<string>",
            "bin": "<string>",
            "fingerprint": "<string>",
            "funding": "<string>",
            "accountNumber": "<string>",
            "accountType": "<string>",
            "bank": "<string>",
            "currency": "<string>",
            "routingNumber": "<string>",
            "provider": "<string>",
            "email": "<string>",
            "address": "<string>",
            "network": "<string>",
            "pixKey": "<string>",
            "pixKeyType": "<string>"
        } },
    "relationships": [
        {
            "targetEntityId": "<string>",
            "relationshipType": "<string>",
            "strength": 123,
            "metadata": {}
        }
    ],
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityType: '<string>',
    entityData: {
      paymentMethod: {
        type: '<string>',
        last4: '<string>',
        brand: '<string>',
        expiryMonth: '<string>',
        expiryYear: '<string>',
        holderName: '<string>',
        issuerCountry: '<string>',
        bin: '<string>',
        fingerprint: '<string>',
        funding: '<string>',
        accountNumber: '<string>',
        accountType: '<string>',
        bank: '<string>',
        currency: '<string>',
        routingNumber: '<string>',
        provider: '<string>',
        email: '<string>',
        address: '<string>',
        network: '<string>',
        pixKey: '<string>',
        pixKeyType: '<string>'
      }
    },
    relationships: [
      {
        targetEntityId: '<string>',
        relationshipType: '<string>',
        strength: 123,
        metadata: {}
      }
    ],
    metadata: {}
  })
};

fetch('http://api.gu1.ai/entities', 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 => "http://api.gu1.ai/entities",
  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([
    'entityType' => '<string>',
    'entityData' => [
        'paymentMethod' => [
                'type' => '<string>',
                'last4' => '<string>',
                'brand' => '<string>',
                'expiryMonth' => '<string>',
                'expiryYear' => '<string>',
                'holderName' => '<string>',
                'issuerCountry' => '<string>',
                'bin' => '<string>',
                'fingerprint' => '<string>',
                'funding' => '<string>',
                'accountNumber' => '<string>',
                'accountType' => '<string>',
                'bank' => '<string>',
                'currency' => '<string>',
                'routingNumber' => '<string>',
                'provider' => '<string>',
                'email' => '<string>',
                'address' => '<string>',
                'network' => '<string>',
                'pixKey' => '<string>',
                'pixKeyType' => '<string>'
        ]
    ],
    'relationships' => [
        [
                'targetEntityId' => '<string>',
                'relationshipType' => '<string>',
                'strength' => 123,
                'metadata' => [
                                
                ]
        ]
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "http://api.gu1.ai/entities"

	payload := strings.NewReader("{\n  \"entityType\": \"<string>\",\n  \"entityData\": {\n    \"paymentMethod\": {\n      \"type\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"brand\": \"<string>\",\n      \"expiryMonth\": \"<string>\",\n      \"expiryYear\": \"<string>\",\n      \"holderName\": \"<string>\",\n      \"issuerCountry\": \"<string>\",\n      \"bin\": \"<string>\",\n      \"fingerprint\": \"<string>\",\n      \"funding\": \"<string>\",\n      \"accountNumber\": \"<string>\",\n      \"accountType\": \"<string>\",\n      \"bank\": \"<string>\",\n      \"currency\": \"<string>\",\n      \"routingNumber\": \"<string>\",\n      \"provider\": \"<string>\",\n      \"email\": \"<string>\",\n      \"address\": \"<string>\",\n      \"network\": \"<string>\",\n      \"pixKey\": \"<string>\",\n      \"pixKeyType\": \"<string>\"\n    }\n  },\n  \"relationships\": [\n    {\n      \"targetEntityId\": \"<string>\",\n      \"relationshipType\": \"<string>\",\n      \"strength\": 123,\n      \"metadata\": {}\n    }\n  ],\n  \"metadata\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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("http://api.gu1.ai/entities")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entityType\": \"<string>\",\n  \"entityData\": {\n    \"paymentMethod\": {\n      \"type\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"brand\": \"<string>\",\n      \"expiryMonth\": \"<string>\",\n      \"expiryYear\": \"<string>\",\n      \"holderName\": \"<string>\",\n      \"issuerCountry\": \"<string>\",\n      \"bin\": \"<string>\",\n      \"fingerprint\": \"<string>\",\n      \"funding\": \"<string>\",\n      \"accountNumber\": \"<string>\",\n      \"accountType\": \"<string>\",\n      \"bank\": \"<string>\",\n      \"currency\": \"<string>\",\n      \"routingNumber\": \"<string>\",\n      \"provider\": \"<string>\",\n      \"email\": \"<string>\",\n      \"address\": \"<string>\",\n      \"network\": \"<string>\",\n      \"pixKey\": \"<string>\",\n      \"pixKeyType\": \"<string>\"\n    }\n  },\n  \"relationships\": [\n    {\n      \"targetEntityId\": \"<string>\",\n      \"relationshipType\": \"<string>\",\n      \"strength\": 123,\n      \"metadata\": {}\n    }\n  ],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.gu1.ai/entities")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entityType\": \"<string>\",\n  \"entityData\": {\n    \"paymentMethod\": {\n      \"type\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"brand\": \"<string>\",\n      \"expiryMonth\": \"<string>\",\n      \"expiryYear\": \"<string>\",\n      \"holderName\": \"<string>\",\n      \"issuerCountry\": \"<string>\",\n      \"bin\": \"<string>\",\n      \"fingerprint\": \"<string>\",\n      \"funding\": \"<string>\",\n      \"accountNumber\": \"<string>\",\n      \"accountType\": \"<string>\",\n      \"bank\": \"<string>\",\n      \"currency\": \"<string>\",\n      \"routingNumber\": \"<string>\",\n      \"provider\": \"<string>\",\n      \"email\": \"<string>\",\n      \"address\": \"<string>\",\n      \"network\": \"<string>\",\n      \"pixKey\": \"<string>\",\n      \"pixKeyType\": \"<string>\"\n    }\n  },\n  \"relationships\": [\n    {\n      \"targetEntityId\": \"<string>\",\n      \"relationshipType\": \"<string>\",\n      \"strength\": 123,\n      \"metadata\": {}\n    }\n  ],\n  \"metadata\": {}\n}"

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

{
  "success": true,
  "id": "<string>",
  "entityType": "<string>",
  "entityData": {},
  "relationships": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Overview

Creates a new payment method entity (credit card, bank account, wallet, etc.) in the system. Payment methods can be linked to person or company entities and used for transaction monitoring and fraud detection.

Endpoint

POST http://api.gu1.ai/entities

Authentication

Requires a valid API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Request Body

string

required

Must be "payment_method" for payment method entities

object

required

Container for payment method data

Show properties

object

required

Payment method details

Show properties

string

required

Type of payment method: credit_card, debit_card, bank_account, digital_wallet, crypto_wallet, pix

string

Last 4 digits of card/account number

string

Card brand (for cards): visa, mastercard, amex, elo, hipercard, etc.

string

Expiration month (for cards): 01 to 12

string

Expiration year (for cards): YYYY format

string

Name on card/account

string

Issuing country code (ISO 3166-1 alpha-2)

string

Bank Identification Number (first 6 digits of card)

string

Unique fingerprint for this payment method

string

Funding type: credit, debit, prepaid, unknown

string

Full account number (for bank accounts, encrypted)

string

Account type: checking, savings, business

string

Bank name (for bank accounts)

string

Currency code (ISO 4217): BRL, USD, ARS, etc.

string

Routing number (for bank accounts)

string

Provider name (for digital wallets): paypal, apple_pay, google_pay, etc.

string

Email associated with wallet (for digital wallets)

string

Wallet address (for cryptocurrency wallets)

string

Network name (for cryptocurrency): bitcoin, ethereum, etc.

string

PIX key (for PIX payment methods in Brazil)

string

PIX key type: cpf, cnpj, email, phone, random

array

Array of relationships to other entities

Show properties

string

required

UUID of the related entity (person or company owner)

string

required

Type of relationship: owns, uses, manages

number

Relationship strength (0.0 to 1.0)

object

Additional relationship metadata

object

Additional metadata for the payment method entity

Example Requests

Create Credit Card

curl -X POST http://api.gu1.ai/entities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "payment_method",
    "entityData": {
      "paymentMethod": {
        "type": "credit_card",
        "last4": "4242",
        "brand": "visa",
        "expiryMonth": "12",
        "expiryYear": "2025",
        "holderName": "John Doe",
        "issuerCountry": "BR",
        "bin": "424242",
        "funding": "credit"
      }
    },
    "relationships": [
      {
        "targetEntityId": "person-uuid-123",
        "relationshipType": "owns",
        "strength": 1.0
      }
    ]
  }'

const response = await fetch('http://api.gu1.ai/entities', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    entityType: 'payment_method',
    entityData: {
      paymentMethod: {
        type: 'credit_card',
        last4: '4242',
        brand: 'visa',
        expiryMonth: '12',
        expiryYear: '2025',
        holderName: 'John Doe',
        issuerCountry: 'BR',
        bin: '424242',
        funding: 'credit'
      }
    },
    relationships: [
      {
        targetEntityId: 'person-uuid-123',
        relationshipType: 'owns',
        strength: 1.0
      }
    ]
  })
});

const paymentMethod = await response.json();
console.log(paymentMethod.id);

import requests

response = requests.post(
    'http://api.gu1.ai/entities',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'entityType': 'payment_method',
        'entityData': {
            'paymentMethod': {
                'type': 'credit_card',
                'last4': '4242',
                'brand': 'visa',
                'expiryMonth': '12',
                'expiryYear': '2025',
                'holderName': 'John Doe',
                'issuerCountry': 'BR',
                'bin': '424242',
                'funding': 'credit'
            }
        },
        'relationships': [
            {
                'targetEntityId': 'person-uuid-123',
                'relationshipType': 'owns',
                'strength': 1.0
            }
        ]
    }
)

payment_method = response.json()
print(payment_method['id'])

Create Bank Account

curl -X POST http://api.gu1.ai/entities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "payment_method",
    "entityData": {
      "paymentMethod": {
        "type": "bank_account",
        "accountNumber": "12345-6",
        "accountType": "checking",
        "bank": "Banco do Brasil",
        "currency": "BRL",
        "routingNumber": "001",
        "holderName": "John Doe"
      }
    },
    "relationships": [
      {
        "targetEntityId": "person-uuid-123",
        "relationshipType": "owns",
        "strength": 1.0
      }
    ]
  }'

const response = await fetch('http://api.gu1.ai/entities', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    entityType: 'payment_method',
    entityData: {
      paymentMethod: {
        type: 'bank_account',
        accountNumber: '12345-6',
        accountType: 'checking',
        bank: 'Banco do Brasil',
        currency: 'BRL',
        routingNumber: '001',
        holderName: 'John Doe'
      }
    },
    relationships: [
      {
        targetEntityId: 'person-uuid-123',
        relationshipType: 'owns',
        strength: 1.0
      }
    ]
  })
});

response = requests.post(
    'http://api.gu1.ai/entities',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={
        'entityType': 'payment_method',
        'entityData': {
            'paymentMethod': {
                'type': 'bank_account',
                'accountNumber': '12345-6',
                'accountType': 'checking',
                'bank': 'Banco do Brasil',
                'currency': 'BRL',
                'routingNumber': '001',
                'holderName': 'John Doe'
            }
        },
        'relationships': [{
            'targetEntityId': 'person-uuid-123',
            'relationshipType': 'owns',
            'strength': 1.0
        }]
    }
)

Create PIX Payment Method

curl -X POST http://api.gu1.ai/entities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "payment_method",
    "entityData": {
      "paymentMethod": {
        "type": "pix",
        "pixKey": "john.doe@example.com",
        "pixKeyType": "email",
        "holderName": "John Doe",
        "currency": "BRL"
      }
    },
    "relationships": [
      {
        "targetEntityId": "person-uuid-123",
        "relationshipType": "owns",
        "strength": 1.0
      }
    ]
  }'

const response = await fetch('http://api.gu1.ai/entities', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    entityType: 'payment_method',
    entityData: {
      paymentMethod: {
        type: 'pix',
        pixKey: 'john.doe@example.com',
        pixKeyType: 'email',
        holderName: 'John Doe',
        currency: 'BRL'
      }
    },
    relationships: [{
      targetEntityId: 'person-uuid-123',
      relationshipType: 'owns',
      strength: 1.0
    }]
  })
});

response = requests.post(
    'http://api.gu1.ai/entities',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    json={
        'entityType': 'payment_method',
        'entityData': {
            'paymentMethod': {
                'type': 'pix',
                'pixKey': 'john.doe@example.com',
                'pixKeyType': 'email',
                'holderName': 'John Doe',
                'currency': 'BRL'
            }
        },
        'relationships': [{
            'targetEntityId': 'person-uuid-123',
            'relationshipType': 'owns',
            'strength': 1.0
        }]
    }
)

Response

boolean

Whether the operation was successful

string

UUID of the created payment method entity

string

Always "payment_method"

object

The payment method data as stored

array

Array of relationships created

string

ISO 8601 timestamp of creation

string

ISO 8601 timestamp of last update

Response Example

{
  "success": true,
  "id": "payment-method-uuid-123",
  "entityType": "payment_method",
  "entityData": {
    "paymentMethod": {
      "type": "credit_card",
      "last4": "4242",
      "brand": "visa",
      "expiryMonth": "12",
      "expiryYear": "2025",
      "holderName": "John Doe",
      "issuerCountry": "BR",
      "bin": "424242",
      "funding": "credit"
    }
  },
  "relationships": [
    {
      "targetEntityId": "person-uuid-123",
      "relationshipType": "owns",
      "strength": 1.0
    }
  ],
  "createdAt": "2024-12-23T10:00:00.000Z",
  "updatedAt": "2024-12-23T10:00:00.000Z"
}

Error Responses

400 Bad Request

{
  "error": "Invalid entity type or missing required fields",
  "details": {
    "entityType": "Must be 'payment_method'",
    "entityData.paymentMethod.type": "Required field"
  }
}

401 Unauthorized

{
  "error": "Invalid or missing API key"
}

​Overview

​Endpoint

​Authentication

​Request Body

​Example Requests

​Create Credit Card

​Create Bank Account

​Create PIX Payment Method

​Response

​Response Example

​Error Responses

​400 Bad Request

​401 Unauthorized

​See Also

Overview

Endpoint

Authentication

Request Body

Example Requests

Create Credit Card

Create Bank Account

Create PIX Payment Method

Response

Response Example

Error Responses

400 Bad Request

401 Unauthorized

See Also