---
agentTools:
  projectIndex: https://chimoney.readme.io/llms.txt
---

# Create a new AI agent account

Creates an agent sub-account with APort passport, multicurrency wallet, and payment pointer

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Chimoney API Docs",
    "version": "0.2.4",
    "description": "This is the latest version of the Chimoney API. For deprecated version routes, please refer to /v0.2/api-docs."
  },
  "security": [
    {
      "apiKeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.chimoney.io/",
      "description": "Prod Server"
    },
    {
      "url": "https://api-v2-sandbox.chimoney.io",
      "description": "Sandbox API v2 (v0.2.4)"
    }
  ],
  "paths": {
    "/v0.2.4/agents/create": {
      "post": {
        "summary": "Create a new AI agent account",
        "description": "Creates an agent sub-account with APort passport, multicurrency wallet, and payment pointer",
        "tags": [
          "Agents"
        ],
        "security": [
          {
            "apiKeyAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Agent name",
                    "example": "PaymentBot"
                  },
                  "description": {
                    "type": "string",
                    "description": "Agent description",
                    "example": "AI Agent for processing payments"
                  },
                  "email": {
                    "type": "string",
                    "format": "email",
                    "description": "Agent email (auto-generated if not provided)",
                    "example": "agent-123@agents.chimoney.io"
                  },
                  "subAccount": {
                    "type": "string",
                    "description": "Sub-account identifier"
                  },
                  "limits": {
                    "type": "object",
                    "description": "Transaction limits",
                    "properties": {
                      "USD": {
                        "type": "object",
                        "properties": {
                          "maxPerTx": {
                            "type": "integer",
                            "example": 10000
                          },
                          "dailyCap": {
                            "type": "integer",
                            "example": 100000
                          }
                        }
                      },
                      "CAD": {
                        "type": "object",
                        "properties": {
                          "maxPerTx": {
                            "type": "integer",
                            "example": 10000
                          },
                          "dailyCap": {
                            "type": "integer",
                            "example": 100000
                          }
                        }
                      },
                      "NGN": {
                        "type": "object",
                        "properties": {
                          "maxPerTx": {
                            "type": "integer",
                            "example": 10000
                          },
                          "dailyCap": {
                            "type": "integer",
                            "example": 100000
                          }
                        }
                      },
                      "MXN": {
                        "type": "object",
                        "properties": {
                          "maxPerTx": {
                            "type": "integer",
                            "example": 10000
                          },
                          "dailyCap": {
                            "type": "integer",
                            "example": 100000
                          }
                        }
                      },
                      "refundAmountMaxPerTx": {
                        "type": "integer",
                        "description": "Maximum refund amount per transaction",
                        "example": 5000
                      },
                      "refundAmountDailyCap": {
                        "type": "integer",
                        "description": "Daily refund cap",
                        "example": 50000
                      },
                      "approvalRequired": {
                        "type": "boolean",
                        "example": false
                      }
                    }
                  },
                  "capabilities": {
                    "type": "array",
                    "description": "Agent capabilities (finance.* or wallet.* only)",
                    "items": {
                      "oneOf": [
                        {
                          "type": "string",
                          "example": "finance.payment.charge"
                        },
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "example": "finance.payment.payout"
                            },
                            "params": {
                              "type": "object"
                            }
                          }
                        }
                      ]
                    }
                  },
                  "regions": {
                    "type": "array",
                    "description": "Allowed regions (ISO country codes)",
                    "items": {
                      "type": "string",
                      "pattern": "^[A-Z]{2}(-[A-Z]{2})?$",
                      "example": "US"
                    }
                  },
                  "meta": {
                    "type": "object",
                    "description": "Additional metadata"
                  },
                  "interledgerWalletAddress": {
                    "type": "string",
                    "description": "Custom Interledger wallet address/payment pointer",
                    "example": "myagent-custom"
                  },
                  "initialFunding": {
                    "oneOf": [
                      {
                        "type": "number",
                        "description": "Initial funding amount (0-1000000)",
                        "example": 100
                      },
                      {
                        "type": "string",
                        "description": "Initial funding as string",
                        "example": "100.50"
                      },
                      {
                        "type": "object",
                        "properties": {
                          "amount": {
                            "type": "number",
                            "example": 100
                          },
                          "currency": {
                            "type": "string",
                            "example": "USD"
                          }
                        }
                      }
                    ],
                    "description": "Initial funding to transfer from parent wallet"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Agent created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "uid": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "email": {
                          "type": "string"
                        },
                        "paymentPointer": {
                          "type": "string"
                        },
                        "aportPassportId": {
                          "type": "string"
                        },
                        "aportDID": {
                          "type": "string"
                        },
                        "assuranceLevel": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/ValidationError"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Access to this resource is not available for unauthenticated users.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Unauthorized"
            }
          }
        }
      },
      "ServerError": {
        "description": "Indicates an internal server error.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ServerError"
            }
          }
        }
      },
      "ValidationError": {
        "description": "Validation error in the request.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ValidationError"
            }
          }
        }
      }
    },
    "schemas": {
      "Unauthorized": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the response.",
            "example": "error"
          },
          "error": {
            "type": "string",
            "description": "Error message indicating unauthorized access.",
            "example": "API key is not defined. Generate a new one from the developer portal."
          }
        }
      },
      "ServerError": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the error.",
            "example": "error"
          },
          "type": {
            "type": "string",
            "description": "Type of server error.",
            "example": "server error"
          },
          "code": {
            "type": "string",
            "description": "Specific error code for server issues.",
            "example": "INTERNAL_SERVER_ERROR"
          },
          "message": {
            "type": "string",
            "description": "Detailed message explaining the issue.",
            "example": "An internal server error occurred."
          }
        }
      },
      "ValidationError": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the validation error.",
            "example": "error"
          },
          "type": {
            "type": "string",
            "description": "Type of validation error.",
            "example": "Validation Error"
          },
          "code": {
            "type": "string",
            "description": "Error code indicating validation issue.",
            "example": "INVALID_REQUEST"
          },
          "message": {
            "type": "string",
            "description": "Detailed validation error message.",
            "example": "The request parameters are invalid."
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Agents",
      "description": "AI Agent wallet management endpoints"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 102,
      "1": 208,
      "2": 243,
      "3": 240,
      "4": 73,
      "5": 214,
      "6": 34,
      "7": 0,
      "8": 37,
      "9": 190,
      "10": 200,
      "11": 166
    }
  }
}
```