Register a farmer

curl --request POST \
  --url https://app.microcrop.app/api/farmers/register \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "phoneNumber": "+254712345678",
  "nationalId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "county": "<string>",
  "subCounty": "<string>",
  "ward": "<string>",
  "village": "<string>"
}
'

import requests

url = "https://app.microcrop.app/api/farmers/register"

payload = {
    "phoneNumber": "+254712345678",
    "nationalId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "county": "<string>",
    "subCounty": "<string>",
    "ward": "<string>",
    "village": "<string>"
}
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({
    phoneNumber: '+254712345678',
    nationalId: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    county: '<string>',
    subCounty: '<string>',
    ward: '<string>',
    village: '<string>'
  })
};

fetch('https://app.microcrop.app/api/farmers/register', 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://app.microcrop.app/api/farmers/register",
  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([
    'phoneNumber' => '+254712345678',
    'nationalId' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'county' => '<string>',
    'subCounty' => '<string>',
    'ward' => '<string>',
    'village' => '<string>'
  ]),
  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://app.microcrop.app/api/farmers/register"

	payload := strings.NewReader("{\n  \"phoneNumber\": \"+254712345678\",\n  \"nationalId\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"county\": \"<string>\",\n  \"subCounty\": \"<string>\",\n  \"ward\": \"<string>\",\n  \"village\": \"<string>\"\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://app.microcrop.app/api/farmers/register")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phoneNumber\": \"+254712345678\",\n  \"nationalId\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"county\": \"<string>\",\n  \"subCounty\": \"<string>\",\n  \"ward\": \"<string>\",\n  \"village\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.microcrop.app/api/farmers/register")

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  \"phoneNumber\": \"+254712345678\",\n  \"nationalId\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"county\": \"<string>\",\n  \"subCounty\": \"<string>\",\n  \"ward\": \"<string>\",\n  \"village\": \"<string>\"\n}"

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

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "nationalId": "<string>",
    "county": "<string>",
    "subCounty": "<string>",
    "kycStatus": "PENDING"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "<string>",
    "details": "<unknown>"
  }
}

POST

farmers

curl --request POST \
  --url https://app.microcrop.app/api/farmers/register \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "phoneNumber": "+254712345678",
  "nationalId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "county": "<string>",
  "subCounty": "<string>",
  "ward": "<string>",
  "village": "<string>"
}
'

import requests

url = "https://app.microcrop.app/api/farmers/register"

payload = {
    "phoneNumber": "+254712345678",
    "nationalId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "county": "<string>",
    "subCounty": "<string>",
    "ward": "<string>",
    "village": "<string>"
}
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({
    phoneNumber: '+254712345678',
    nationalId: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    county: '<string>',
    subCounty: '<string>',
    ward: '<string>',
    village: '<string>'
  })
};

fetch('https://app.microcrop.app/api/farmers/register', 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://app.microcrop.app/api/farmers/register",
  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([
    'phoneNumber' => '+254712345678',
    'nationalId' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'county' => '<string>',
    'subCounty' => '<string>',
    'ward' => '<string>',
    'village' => '<string>'
  ]),
  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://app.microcrop.app/api/farmers/register"

	payload := strings.NewReader("{\n  \"phoneNumber\": \"+254712345678\",\n  \"nationalId\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"county\": \"<string>\",\n  \"subCounty\": \"<string>\",\n  \"ward\": \"<string>\",\n  \"village\": \"<string>\"\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://app.microcrop.app/api/farmers/register")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phoneNumber\": \"+254712345678\",\n  \"nationalId\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"county\": \"<string>\",\n  \"subCounty\": \"<string>\",\n  \"ward\": \"<string>\",\n  \"village\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.microcrop.app/api/farmers/register")

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  \"phoneNumber\": \"+254712345678\",\n  \"nationalId\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"county\": \"<string>\",\n  \"subCounty\": \"<string>\",\n  \"ward\": \"<string>\",\n  \"village\": \"<string>\"\n}"

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

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "nationalId": "<string>",
    "county": "<string>",
    "subCounty": "<string>",
    "kycStatus": "PENDING"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

x-api-key

string

header

required

Body

application/json

phoneNumber

string

required

Pattern: ^\+254\d{9}$

Example:

"+254712345678"

nationalId

string

required

Required string length: 6 - 20

firstName

string

required

lastName

string

required

county

string

required

subCounty

string

required

ward

string

village

string

Response

Created

success

boolean

Example:

true

data

object

Show child attributes

Overview

Endpoints

Authorizations

Body

Response