cURL

curl --request PUT \
  --url https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "step": "<string>",
  "document": {
    "fileExtension": "<string>",
    "base64Content": "<string>"
  },
  "information": {
    "cornerStoreType": "<string>",
    "businessLifetime": "<string>",
    "ownershipStatus": "<string>",
    "cornerStoreName": "<string>",
    "cornerStoreAddress": "<string>",
    "localeOwner": "<string>"
  }
}
'

import requests

url = "https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding"

payload = {
    "step": "<string>",
    "document": {
        "fileExtension": "<string>",
        "base64Content": "<string>"
    },
    "information": {
        "cornerStoreType": "<string>",
        "businessLifetime": "<string>",
        "ownershipStatus": "<string>",
        "cornerStoreName": "<string>",
        "cornerStoreAddress": "<string>",
        "localeOwner": "<string>"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    step: '<string>',
    document: {fileExtension: '<string>', base64Content: '<string>'},
    information: {
      cornerStoreType: '<string>',
      businessLifetime: '<string>',
      ownershipStatus: '<string>',
      cornerStoreName: '<string>',
      cornerStoreAddress: '<string>',
      localeOwner: '<string>'
    }
  })
};

fetch('https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding', 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://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'step' => '<string>',
    'document' => [
        'fileExtension' => '<string>',
        'base64Content' => '<string>'
    ],
    'information' => [
        'cornerStoreType' => '<string>',
        'businessLifetime' => '<string>',
        'ownershipStatus' => '<string>',
        'cornerStoreName' => '<string>',
        'cornerStoreAddress' => '<string>',
        'localeOwner' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding"

	payload := strings.NewReader("{\n  \"step\": \"<string>\",\n  \"document\": {\n    \"fileExtension\": \"<string>\",\n    \"base64Content\": \"<string>\"\n  },\n  \"information\": {\n    \"cornerStoreType\": \"<string>\",\n    \"businessLifetime\": \"<string>\",\n    \"ownershipStatus\": \"<string>\",\n    \"cornerStoreName\": \"<string>\",\n    \"cornerStoreAddress\": \"<string>\",\n    \"localeOwner\": \"<string>\"\n  }\n}")

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

	req.Header.Add("Authorization", "<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.put("https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"step\": \"<string>\",\n  \"document\": {\n    \"fileExtension\": \"<string>\",\n    \"base64Content\": \"<string>\"\n  },\n  \"information\": {\n    \"cornerStoreType\": \"<string>\",\n    \"businessLifetime\": \"<string>\",\n    \"ownershipStatus\": \"<string>\",\n    \"cornerStoreName\": \"<string>\",\n    \"cornerStoreAddress\": \"<string>\",\n    \"localeOwner\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"step\": \"<string>\",\n  \"document\": {\n    \"fileExtension\": \"<string>\",\n    \"base64Content\": \"<string>\"\n  },\n  \"information\": {\n    \"cornerStoreType\": \"<string>\",\n    \"businessLifetime\": \"<string>\",\n    \"ownershipStatus\": \"<string>\",\n    \"cornerStoreName\": \"<string>\",\n    \"cornerStoreAddress\": \"<string>\",\n    \"localeOwner\": \"<string>\"\n  }\n}"

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

PUT

account

{userId}

verification

{verificationId}

onboarding

cURL

curl --request PUT \
  --url https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "step": "<string>",
  "document": {
    "fileExtension": "<string>",
    "base64Content": "<string>"
  },
  "information": {
    "cornerStoreType": "<string>",
    "businessLifetime": "<string>",
    "ownershipStatus": "<string>",
    "cornerStoreName": "<string>",
    "cornerStoreAddress": "<string>",
    "localeOwner": "<string>"
  }
}
'

import requests

url = "https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding"

payload = {
    "step": "<string>",
    "document": {
        "fileExtension": "<string>",
        "base64Content": "<string>"
    },
    "information": {
        "cornerStoreType": "<string>",
        "businessLifetime": "<string>",
        "ownershipStatus": "<string>",
        "cornerStoreName": "<string>",
        "cornerStoreAddress": "<string>",
        "localeOwner": "<string>"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    step: '<string>',
    document: {fileExtension: '<string>', base64Content: '<string>'},
    information: {
      cornerStoreType: '<string>',
      businessLifetime: '<string>',
      ownershipStatus: '<string>',
      cornerStoreName: '<string>',
      cornerStoreAddress: '<string>',
      localeOwner: '<string>'
    }
  })
};

fetch('https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding', 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://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'step' => '<string>',
    'document' => [
        'fileExtension' => '<string>',
        'base64Content' => '<string>'
    ],
    'information' => [
        'cornerStoreType' => '<string>',
        'businessLifetime' => '<string>',
        'ownershipStatus' => '<string>',
        'cornerStoreName' => '<string>',
        'cornerStoreAddress' => '<string>',
        'localeOwner' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding"

	payload := strings.NewReader("{\n  \"step\": \"<string>\",\n  \"document\": {\n    \"fileExtension\": \"<string>\",\n    \"base64Content\": \"<string>\"\n  },\n  \"information\": {\n    \"cornerStoreType\": \"<string>\",\n    \"businessLifetime\": \"<string>\",\n    \"ownershipStatus\": \"<string>\",\n    \"cornerStoreName\": \"<string>\",\n    \"cornerStoreAddress\": \"<string>\",\n    \"localeOwner\": \"<string>\"\n  }\n}")

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

	req.Header.Add("Authorization", "<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.put("https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"step\": \"<string>\",\n  \"document\": {\n    \"fileExtension\": \"<string>\",\n    \"base64Content\": \"<string>\"\n  },\n  \"information\": {\n    \"cornerStoreType\": \"<string>\",\n    \"businessLifetime\": \"<string>\",\n    \"ownershipStatus\": \"<string>\",\n    \"cornerStoreName\": \"<string>\",\n    \"cornerStoreAddress\": \"<string>\",\n    \"localeOwner\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging-api.propaga.io/v1/account/{userId}/verification/{verificationId}/onboarding")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"step\": \"<string>\",\n  \"document\": {\n    \"fileExtension\": \"<string>\",\n    \"base64Content\": \"<string>\"\n  },\n  \"information\": {\n    \"cornerStoreType\": \"<string>\",\n    \"businessLifetime\": \"<string>\",\n    \"ownershipStatus\": \"<string>\",\n    \"cornerStoreName\": \"<string>\",\n    \"cornerStoreAddress\": \"<string>\",\n    \"localeOwner\": \"<string>\"\n  }\n}"

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

Corner Store Onboarding

To onboard a corner store, this endpoint must be called. Before that, the create-verification use case must be invoked to obtain the verificationId required by this endpoint.

Create verification use case

Get more information about how call verification use-case

Important Considerations:

To send images to this endpoint, the base64 content of the image and its file extension must be provided. The optimal requirements for sending images are:

Clarity and Quality: Use clear, high-quality images without excessive shadows.
Positioning: The subject’s face should be centered and unobstructed by objects such as glasses, hats, or face masks. The entire face must be visible.
Size: The recommended image size is between 250 KB and 1 MB.
Format: We recommend using JPEG or PNG formats.
Colors: The image must be in color, not black and white.
Dimensions: The image should have a minimum width of 750 pixels.
Document Coverage (for INE): The document should cover at least 70% of the total image area.

How to Use This Endpoint

To use this endpoint, follow these steps:

First, call the create-verification use case to obtain the verificationId.
Next, use this endpoint to send the images and corner store information using the following request body example:

{
    "step": "DOCUMENT_IMAGE_FRONTAL",
    "document": {
        "fileExtension": "png",
        "base64Content": "base64 encoded content of the image"
    }
}

Then, you need to call this endpoint again to send the information of the corner store, following the next body example:

{
    "step": "CORNER_STORE_INFORMATION",
    "information": {
        "cornerStoreType": "GROCERY_STORE",
        "businessLifetime": "LESS_THAN_ONE_YEAR",
        "ownershipStatus": "SOLE_PROPRIETOR",
        "cornerStoreName": "Corner store name",
        "cornerStoreAddress": "Corner store address",
        "localeOwner": "PROPIO"
    }
}

Finally, you need to notify when user finished the onboarding, following the next body example:

{
    "step": "COMPLETED"
}

Path parameters

string

required

Propaga’s user id

string

required

Verification id generated when you call the create verification use-case

Body

string

default:"DOCUMENT_IMAGE_FRONTAL"

required

Show Step values

object

Show Properties

string

required

Show File extension values

string

required

Base64 encoded content of the image

object

Show Properties

string

required

Show Store type values

string

required

Show Business lifetime values

string

required

Show Ownership status values

string

required

Corner store’s name

string

required

Corner store’s address

string

required

Show Locale owner values

Overview

Getting started

API Reference

Onboarding

Corner Store Onboarding

Create verification use case

Important Considerations:

How to Use This Endpoint

Path parameters

Body

​Corner Store Onboarding

Create verification use case

​Important Considerations:

​How to Use This Endpoint

​Path parameters

​Body

Corner Store Onboarding

Important Considerations:

How to Use This Endpoint

Path parameters

Body