The Riminder Developer Hub

Welcome to the Riminder developer hub. You'll find comprehensive guides and documentation to help you start working with Riminder as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    
Suggest Edits

Authentication

 

Authentication to all WEBSITE API endpoints are done via your account’s API key.

After creating your account, you can retrieve your account’s API key in the dashboard. You can find instructions to get your key in the Getting Started section.

X-API-Key: DEMO_KEY

Requests are authenticated using a HTTP header called X-API-Key. Pass your API key (ex: DEMO_KEY) into the X-API-Key header. You do not need to provide an auth username or a password.
Curl example:

curl endpoint_url -H "X-API-Key: DEMO_KEY"

Pick which ever method is easiest for you.

Code Title Description

HTTP Status codes

Our API returns standard HTTP success or error status codes.
Code Title Description

Code
Title
Description

200

OK

The request was successful.

201

Created

The resource was successfully created.

202

Async created

The resource was asynchronously created.

400

Bad request

Bad request

401

Unauthorized

Your API key is invalid.

402

Over quota

Over plan quota on this endpoint.

404

Not found

The resource does not exist.

422

Validation error

A validation error occurred.

50X

Internal Server Error

An error occurred with our API.

Suggest Edits

/sources

Retrieve all sources for given team account

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/sources
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

app.source.list().then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');
	$data = $client->source->list();
	print($data[0]['source_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/sources" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')
resp = client.source.list()

print(resp['data'][0]['source_id'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    var data = client.source.list();
    Console.WriteLine(data[0].name);
  }
}

import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    List<Token> data = client.Source().list();
    System.out.println(data.get(0).asMap().get("name").as());
  }
}

require 'riminder'

client = Riminder.new('api_key')
data = client.source.list

puts(data[0]['name'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")
	data, _ := client.Source().List()

	fmt.Println(data[0].Name)
}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": [
    {
      "source_id": "7c94e981cd23d16f5c549eea21a7554db0c927a7",
      "name": "Careers website",
      "type": "api",
      "archive": false,
      "count_source": 930,
      "date_creation": {
        "date": "2017-05-25 17:45:32.000000",
        "timezone_type": 3,
        "timezone": "Europe/Paris"
      }
    },
    {
      "source_id": "550030a82f3a3b90c5442f93a3c215e3efbfbdea",
      "name": "chatbot",
      "type": "cvbot",
      "archive": false,
      "count_source": 1498,
      "date_creation": {
        "date": "2017-05-25 17:48:01.000000",
        "timezone_type": 3,
        "timezone": "Europe/Paris"
      }
    }
  ]
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}
 

Response

Field
Type
Description

source_id

string

source id

name

string

source custom name

type

string

source type (cvbot,folder,redirection,
imap,campaign,facebook,gmail,office,api).

archive

boolean

source status wether archived or not

count_source

integer

number of profiles of a source

date_creation

datetime

date of creation of the source

Suggest Edits

/source

Retrieve the source information associated with source id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/source
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  source_id: "source_id"
}

app.source.get(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');
	$data = $client->source->get("7c94e981cd23d16f5c549eea21a7554db0c927a7");
	print($data['source_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/source?source_id=source_id" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')
resp = client.source.get('7c94e981cd23d16f5c549eea21a7554db0c927a7')

print(resp['data']['source_id'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    
    var data = client.source.get(source_id);
    Console.WriteLine(data.name);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    Map<String, Token> data = client.Source().get("7c94e981cd23d16f5c549eea21a7554db0c927a7");
    System.out.println(data.get("name").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')

source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7"

data = client.source.get source_id

puts(data['name'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")

	source_id := "7c94e981cd23d16f5c549eea21a7554db0c927a7"

	data, _ := client.Source().Get(map[string]interface{}{"source_id": source_id})

	fmt.Println(data["name"])

}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": {
    "source_id": "7c94e981cd23d16f5c549eea21a7554db0c927a7",
    "name": "Careers website",
    "type": "api",
    "archive": false,
    "count_source": 930,
    "date_creation": {
      "date": "2017-05-25 17:45:32.000000",
      "timezone_type": 3,
      "timezone": "Europe/Paris"
    }
  }
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Fobidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Query Params

source_id
string

source id.

 

Response

Field
Type
Description

source _id

string

source id.

name

string

source custom name.

type

string

source type (cvbot,folder,redirection,
imap,campaign,facebook, gmail,office,api).

archive

boolean

source status wether archived or not.

count_source

integer

number of all profiles of a source.

date_creation

datetime

date of creation of the source.

Suggest Edits

/filters

Retrieve all sources for given team account

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/filters
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

app.filter.list().then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');
	$data = $client->filter->list();
	print($data[0]['filter_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/filters" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')
resp = client.filter.list()

print(resp['data'][0]['filter_id'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var data = client.filter.list();
    Console.WriteLine(data[0].name);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    List<Token> data = client.Filter().list();
    System.out.println(data.get(0).asMap().get("name").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')
data = client.filter.list

puts(data[0]['name'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")
	data, _ := client.Filter().List()

	fmt.Println(data[0].Name)
}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": [
    {
      "filter_id": "7c94e981cd23d16f5c549eea21a7554db0c927a7",
      "filter_reference": "1248593",
      "name": "Talent Acquisition Specialist",
      "archive": false,
      "date_creation": {
        "date": "2017-07-27 18:49:41.000000",
        "timezone_type": 3,
        "timezone": "Europe/Paris"
      }
    },
    {
      "filter_id": "550030a82f3a3b90c5442f93a3c215e3efbfbdea",
      "filter_reference": "9594949",
      "name": "Accounting assistant",
      "archive": false,
      "date_creation": {
        "date": "2017-07-31 16:31:29.000000",
        "timezone_type": 3,
        "timezone": "Europe/Paris"
      }
    }
  ]
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}
 

Response

Field
Type
Description

filter_id

string

filter id.

filter_reference

string

filter reference (customizable in the filter edition modal).

name

string

filter custom name.

archive

boolean

filter status wether archived or not.

date_creation

datetime

date of creation of the filter.

Suggest Edits

/filter

Retrieve the source information associated with source id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/filter
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  filter_id: "filter_id",
  // Or
  filter_reference: "filter_reference"
}

app.filter.get(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');

	$data = $client->filter->get(new FilterID('7c14e981cd232l6f5c549eea21a7554db0d221a7'));
	print($data['filter_id']);

	$data = $client->filter->get(new FilterReference('593850'));
	print($data['filter_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/filter?filter_id=filter_id" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')
resp = client.filter.get(filter_id='7c94e981cd23d16f5c549eea21a7554db0c927a7')
print(resp['data']['filter_id'])

resp = client.filter.get(filter_referrence='reference0')
print(resp['data']['filter_id'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "34t4e981cd232l6f5c549eegh1a7554db0d2256y";
    var filter_id = "7c14e981cd232l6f5c549eea21a7554db0d221a7";
    var filter_ref = "593850";
    
    // With filter id
    var data0 = client.filter.get(source_id, filter_id);
    Console.WriteLine(data0.name);
    
    // With filter reference
    var data1 = client.filter.get(source_id, filter_reference: filter_ref);
    Console.WriteLine(data1.name);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    Map<String, Token> data = client.Filter().get("7c94e981cd23d16f5c549eea21a7554db0c927a7");
    System.out.println(data.get("name").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')

filter_id = "4594e981cd23d16f5c549eea21a7554db0c92745"
filter_reference = "reference0"

data0 = client.filter.get "filter_id" => filter_id
data1 = client.filter.get "filter_reference" => filter_reference

puts(data0['name'])
puts(data1['name'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")

	filterID := "4594e981cd23d16f5c549eea21a7554db0c92745"
	filterReference := "reference0"

	data0, _ := client.Filter().Get(map[string]interface{}{"filter_id": filterID})
	data1, _ := client.Filter().Get(map[string]interface{}{"filter_reference": filterReference})

	fmt.Println(data0.Name)
	fmt.Println(data1.Name)

}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": {
    "filter_id": "7c14e981cd232l6f5c549eea21a7554db0d221a7",
    "filter_reference": "593850",
    "name": "Senior AI Researcher",
    "description": "• 4+ years of practical experience or proven track record (projects, papers : ideally at ICML, ACL, EMNLP, TACL, CVPR, ICCV, or NIPS.) on Deep Learning.APPLY",
    "score_threshold": 0.9,
    "template": {
      "name": "Data Scientist"
    },
    "seniority": "senior",
    "countries": ["France", "China"],
    "archive": false,
    "date_creation": {
      "date": "2017-05-25 17:50:01.000000",
      "timezone_type": 3,
      "timezone": "Europe/Paris"
    }
  }
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Fobidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Query Params

filter_id
string
filter_reference
string

filter reference (customizable in the job edition modal).

 

Response

Field
Type
Description

filter _id

string

filter id.

filter _reference

string

filter reference (customizable in the filter edition modal).

name

string

filter custom name.

description

string

filter description or purpose.

score_threshold

float

minimum matching score ([0,1]) to receive a profile notification for a filter.

template

object

Pre-made template already trained on millions of worldwide career's paths.

template.name

string

filter name.

seniority

string

filter seniority (junior or
senior).

skills

array

filter mandatory skills.

archive

boolean

filter status wether archived or not.

stages

object

filter stages (NO ,LATER, YES).

stages.count_yes

integer

number of all profiles associated to the stage YES of the filter.

stages.count_later

integer

number of all profiles associated to the stage LATER of the filter.

stages.count_no

integer

number of all profiles associated to the stage NO of the filter.

date_creation

datetime

date of creation of the filter.

 
Suggest Edits

/profile

Add a resume to a sourced id

 

Header Auth

 Authentication is required for this endpoint.
posthttps://www.riminder.net/sf/public/api/v1.0/profile
import * as fs from "fs";
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const data = {
    source_id: "source_id",
    profile_reference: "reference",
    timestamp_reception: new Date(Date.now()),
    training_metadata: [{
        filter_reference: "filter_reference",
        rating: 2,
        rating_timestamp: Date.now(),
        stage: Stage.LATER,
        stage_timestamp: Date.now()
    }]
}

app.profile.add(data, fs.createReadStream("/file/path/name.pdf")).then(responseData => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');

	$source_id = '7c94e981cd23d16f5c549eea21a7554db0c927a7';
	$file_path = 'path/to/file';
  $profile_reference = 'reference0';
  $timestamp_reception = 1529682824;
	$trainning_metadata = [
    'filter_reference' => 'reference01',
    'stage' => 'NO',
    'stage_timestamp' => 1529682824,
    'rating' => '3',
    'rating_timestamp' => 1529682824
  ];
	$data = $client->profile->add($source_id, $file_path, $profile_reference,
                                $timestamp_reception, $training_metadata);
	print($data['data']['profile_reference']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile" \
-F "source_id=source_id" \
-F "file=@resume.pdf" \
-F "profile_reference=reference" \
-F "timestamp_reception=1234567890" \
-F "training_metadata=[{\"filter_reference\":\"filter_reference\",\"stage\":\"YES\",\"stage_timestamp\":1234,\"rating\":1,\"rating_timestamp\":2345}]" \
--header "X-API-KEY: api_key"
import riminder
import time

api_key = "ask_5bc35b594cd4f2725f21b9a705c0f711"
source_id = "f06a369b42d76ac79f96338c44b2d574862bc6f3"
filter_reference = "12345"

client = riminder.Riminder(api_key)
metadata = [{
        "filter_reference": filter_reference,
        "rating": 2,
        "rating_timestamp": int(time.time()),
        "stage": "LATER",
        "stage_timestamp": int(time.time())
    }]
resp = client.profile.add(source_id=source_id,
                          file_path="/path/to/file",
                          profile_reference="reference0",
                          training_metadata=metadata)

print(resp)
using System;
using Riminder;

// for TrainingMetadatas
using Riminder.response;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "34t4e981cd232l6f5c549eegh1a7554db0d2256y";
    var file_path = "path/to/file";
    var profile_reference = "49583";
    var timestamp_reception = "1495727300";
    var training_metadata = new TrainingMetadatas()
    {
      {new TrainingMetadata()
        {
          filter_reference = "12345",
          stage = "YES",
          stage_timestamp = 1527263300,
          rating = 4,
          rating_timestamp = 1527263300
        }
      },
      {new TrainingMetadata()
        {
          filter_reference = "54321",
          stage = "N0",
          stage_timestamp = 1527263300,
          rating = 1,
          rating_timestamp = 1527263300
        }
      },
    }
    
    var data = client.profile.add(source_id, file_path, 
                                  profile_reference, timestamp_reception,
                                  training_metadata);
    Console.WriteLine(data.file_id);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.route.Profile.TrainingMetadata;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    String source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    String file_path = "path/to/file";
    String profile_reference = "49583";
    Long timestamp_reception = 1534868230;
    List<TrainingMetadata> training_metadata = new ArrayList<>();
    TrainingMetadata trainingMetadata = new TrainingMetadata();
    trainingMetadata.filter_reference = "reference0";
    trainingMetadata.rating = 3;
    trainingMetadata.rating_timestamp = 1534868230;
    trainingMetadata.stage = Constants.Stage.LATER;
    trainingMetadata.stage_timestamp = 1534868230;
   	training_metadata.add(trainingMetadata);

    
    Map<String, Token> data = client.Profile().add(source_id, 
                                        file_path, profile_reference, 
                                        timestamp_reception, training_metadatas);
    System.out.println(data.get("name").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')

training_metadata = [
    {
        "filter_reference" => "reference0",
        "stage" => "NO",
        "stage_timestamp" => "1536619600",
        "rating" => "1",
        "rating_timestamp" => "1536619600"
    },
    {
        "filter_reference" => "reference1",
        "stage" => "YES",
        "stage_timestamp" => "1536619600",
        "rating" => "4",
        "rating_timestamp" => "1536619600"
    }
]
source_id = "4594e981cd23d16f5c549eea21a7554db0c92745"
file_path = "/path/to/file"
profile_reference = "49583"
timestamp_reception = 1527263300

data = client.profile.add "source_id" => source_id, 
    "filepath" => file_path, "profile_reference" => profile_reference,
    "timestamp_reception" => timestamp_reception, "training_metadata" => training_metadata

puts(data['file_id'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {

	client := riminder.New("api_key")

	training_metadata := []map[string]string{
		{
			"filter_reference": "reference0",
			"stage":            "NO",
			"stage_timestamp":  "1536619600",
			"rating":           "1",
			"rating_timestamp": "1536619600",
		},
		{
			"filter_reference": "reference1",
			"stage":            "YES",
			"stage_timestamp":  "1536619600",
			"rating":           "4",
			"rating_timestamp": "1536619600",
		},
	}
	sourceID := "4594e981cd23d16f5c549eea21a7554db0c92745"
	filepath := "/path/to/file"
	profileReference := "49583"
	timestampReception := 1527263300

	data, _ := client.Profile().Add(map[string]interface{}{"source_id": sourceID,
		"filepath": filepath, "profile_reference": profileReference,
		"timestamp_reception": timestampReception, "training_metadata": training_metadata})

	fmt.Println(data.FileID)
}
A binary file was returned

You couldn't be authenticated

{
  "code": 201,
  "message": "ok",
  "data": {
    "profile_reference": "49583",
    "file_id": "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg",
    "file_name": "resume.pdf",
    "file_size": 16330,
    "extension": "pdf",
    "date_reception": {
      "date": "2017-05-25 17:48:20.000000",
      "timezone_type": 3,
      "timezone": "Europe/Paris"
    },
  }
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Body Params

source_id
string
required

source id

file
file
required

profile file

profile_reference
string

reference to assign to the profile

timestamp_reception
date-time

original date of the application of the profile.

training_metadata
array of objects

list of training metadata associated with different filters

filter_reference
stage
stage_timestamp
rating
rating_timestamp
 

Response

Field
Type
Description

profile_reference

string

profile reference (customizable in the PROFILE API POST).

file_id

string

document file id.

file_name

string

document file name.

file_size

string

document file size in bytes.

extension

string

document extension.

date_reception

datetime

original date of the application of the profile (customizable in the PROFILE API POST).

Document type

The document will be attached to source only if our backend identified it as a "resume".

Suggest Edits

/profile/json/check

Check if a parsed resume is valid.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://www.riminder.net/sf/public/api/v1.0/profile/json
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const data = {
  profile_json: {
  profile_json: {
    name: "Marty McFly",
    email: "marty.mcfly@gmail.com",
    phone: "202-555-0141",
    summary: "High school student, loves to time travel",
    timestamp_reception: new Date("1985-10-21"),
    location_details: {
      text: "9303 Lyon Drive, Lyon Estates, Hill Valley CA 95420"
    },
    experiences: [{
      start: "01/01/2017",
      end: "01/01/2018",
      title: "CusCo employee",
      company: "CusCo",
      location_details: {
        text: "Hill Valley"
      },
      location: "Hill Valley",
      description: "Fujitsu company"
    }],
    educations: [{
      start: "01/01/1985",
      end: "01/01/1986",
      title: "Hill Valley High School",
      school: "Hill Valley High School",
      location_details: {
        text: "Hill Valley"
      },
      location: "Hill Valley",
      description: "a school"
    }],
    skills: [
      "skate",
      "time travel"
    ],
    languages: [
      "english"
    ],
    interests: [
      "music",
    ],
    urls: {
      from_resume: [
        "test.com"
      ],
      linkedin: "",
      twitter: "",
      facebook: "",
      github: "",
      picture: ""
    }
  }
};

app.profile.json.check(data).then(data => {
  // Your treatment here
});
import riminder
import time

client = riminder.Riminder('api_key')
profile_data = {
  "name": "Marty McFly",
  "email": "marty.mcfly@gmail.com",
  "phone": "202-555-0131",
  "summary": "High school student, loves to time travel",
  "timestamp_reception": int(time.time()),
  "location_details": {
    "text": "9303 Lyon Drive, Lyon Estates, Hill Valley CA 95420"
  },
  "experiences": [{
      "start": "01/01/2017",
      "end": "01/01/2018",
      "title": "CusCo employee",
      "company": "CusCo",
      "location_details": {
        "text": "Hill Valley"
      },
      "location": "Hill Valley",
      "description": "Fujitsu company"
    }],
  "educations": [{
      "start": "01/01/1985",
      "end": "01/01/1986",
      "title": "Hill Valley High School",
      "school": "Hill Valley High School",
      "location_details": {
        "text": "Hill Valley"
      },
      "location": "Hill Valley",
      "description": "a school"
    }],
  "skills": [
    "skate",
    "time travel"
  ],
  "languages": [
    "english"
  ],
  "interests": [
    "music"
  ],
  "urls": {
    "from_resume": [
      "test.com"
    ],
    "linkedin": "",
    "twitter": "",
    "facebook": "",
    "github": "",
    "picture": ""
  }
}
resp = client.profile.json.check(profile_data=profile_data)

print(resp)
<?php
require __DIR__ . '/vendor/autoload.php';
$client = new Riminder('api_key');
$profileData = [
  "name" => "Marty McFly",
  "email" => "marty.mcfly@gmail.com",
  "phone" => "202-555-0131",
  "summary" => "High school student, loves to time travel",
  "timestamp_reception" => time(),
  "location_details" => [
    "text" => "9303 Lyon Drive, Lyon Estates, Hill Valley CA 95420"
  ],
  "experiences" => [
    [
      "start" => "01/01/2017",
      "end" => "01/01/2018",
      "title" => "CusCo employee",
      "company" => "CusCo",
      "location_details" => [
        "text" => "Hill Valley"
      ],
      "location" => "Hill Valley",
      "description" => "Fujitsu company"
    ]
  ],
  "educations" => [
    [
      "start" => "01/01/1985",
      "end" => "01/01/1986",
      "title" => "Hill Valley High School",
      "school" => "Hill Valley High School",
      "location_details" => [
        "text" => "Hill Valley"
      ],
      "location" => "Hill Valley",
      "description" => "a school"
    ]
  ],
  "skills" => [
    "skate",
    "time travel"
  ],
  "languages" => [
    "english"
  ],
  "interests" => [
    "music"
  ],
  "urls" => [
    "from_resume" => [
      "test.com"
    ],
    "linkedin" => "",
    "twitter" => "",
    "facebook" => "",
    "github" => "",
    "picture" => ""
  ]
];

$data = $client->profile->json->check($profileData);
print($data);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile/json/check" \
--request POST \
--data "{ \
    \"profile_json\": { \
        \"name\": \"Marty McFly\", \
        \"email\": \"marty.mcfly@gmail.com\", \
        \"phone\": \"202-555-0141\", \
        \"summary\": \"High school student, loves to time travel\", \
        \"timestamp_reception\": \"1985-10-21T00:00:00.000Z\", \
        \"location_details\": { \
            \"text\": \"9303 Lyon Drive, Lyon Estates, Hill Valley CA 95420\" \
        }, \
        \"experiences\": [ \
            { \
                \"start\": \"01/01/2017\", \
                \"end\": \"01/01/2018\", \
                \"title\": \"CusCo employee\", \
                \"company\": \"CusCo\", \
                \"location_details\": { \
                    \"text\": \"Hill Valley\" \
                }, \
                \"location\": \"Hill Valley\", \
                \"description\": \"Fujitsu company\" \
            } \
        ], \
        \"educations\": [ \
            { \
                \"start\": \"01/01/1985\", \
                \"end\": \"01/01/1986\", \
                \"title\": \"Hill Valley High School\", \
                \"school\": \"Hill Valley High School\", \
                \"location_details\": { \
                    \"text\": \"Hill Valley\" \
                }, \
                \"location\": \"Hill Valley\", \
                \"description\": \"a school\" \
            } \
        ], \
        \"skills\": [ \
            \"skate\", \
            \"time travel\" \
        ], \
        \"languages\": [ \
            \"english\" \
        ], \
        \"interests\": [ \
            \"music\" \
        ], \
        \"urls\": { \
            \"from_resume\": [ \
                \"test.com\" \
            ], \
            \"linkedin\": \"\", \
            \"twitter\": \"\", \
            \"facebook\": \"\", \
            \"github\": \"\", \
            \"picture\": \"\" \
        } \
    } \
}" --header "X-API-KEY: api_key"
using System;
using Riminder;

// for TrainingMetadatas
using Riminder.response;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");

    var profileData = new Riminder.response.ProfileJson()
            {
                name = "Salvar Hardon",
                email = "sssalvorrr.54haaardiiin@gmail.com",
                phone = "0678524695",
                summary = "Former mayor of Terminuis I resolve one of the first Sheldon Crisis.",
                location_details = new Riminder.response.ProfileJson.LocationDetails()
                {
                    text = "Terminus, Terminuis"
                },
                experiences = new List<Riminder.response.ProfileJson.Experience>()
                {
                    {new Riminder.response.ProfileJson.Experience
                    {
                        start = "21/1/45",
                        end = "12/12/55",
                        title = "Mayor",
                        company = "Fondations",
                        location = null,
                        location_details = new Riminder.response.ProfileJson.LocationDetails()
                        {
                            text = "Terminus, Terminus"
                        },
                        description = "Save the Fondation."
                    }}
                },
                educations = new List<Riminder.response.ProfileJson.Education>()
                {
                    {new Riminder.response.ProfileJson.Education
                    {
                        start = "21/1/30",
                        end = "12/12/40",
                        title = "something",
                        school = "Fondation hard school",
                        location = null,
                        location_details = new Riminder.response.ProfileJson.LocationDetails()
                        {
                            text = "Terminus, Terminuis"
                        },
                        description = "..."
                    }}
                },
                skills = new List<string>()
                {
                    "diplomacy", "Politics", "Future Science", "Flight"
                },
                languages = new List<string>()
                {
                    "English"
                },
                interests = new List<string>()
                {
                    "cigor", "Fondation"
                },
                urls = new Riminder.response.ProfileJson.Urls()
                {
                    from_resume = new List<string>(),
                    linkedin = null,
                }
                
            };
    var data = client.profile.json.check(profileData);
    Console.WriteLine(data.profile_json.name);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.route.Profile.TrainingMetadata;
import net.riminder.riminder.route.Profile.Json.Education;
import net.riminder.riminder.route.Profile.Json.Experience;
import net.riminder.riminder.route.Profile.Json.LocationDetails;
import net.riminder.riminder.route.Profile.Json.ProfileJson;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    Long timestamp_reception = 1534868230;
    List<TrainingMetadata> training_metadatas = new ArrayList<>();
    TrainingMetadata trainingMetadata = new TrainingMetadata();
    trainingMetadata.filter_reference = "reference0";
    trainingMetadata.rating = 3;
    trainingMetadata.rating_timestamp = 1534868230;
    trainingMetadata.stage = Constants.Stage.LATER;
    trainingMetadata.stage_timestamp = 1534868230;
   	training_metadatas.add(trainingMetadata);
    
    ProfileJson profile_data = new ProfileJson();
    profile_data.name = "Love Lover";
    profile_data.email = "Lovelover@gmail.com";
    profile_data.phone = "+3369895421";
    profile_data.summary = "Les loeleleeleeldkffkjfjfffkfkffffkf.";
    profile_data.locationDetails.text = "Mars, sector 7, 45e Cadran";
    Experience exp = new Experience();
    exp.start = "23/04/2015";
    exp.end = "12/06/2015";
    exp.title = "Some guy";
    exp.company = "Bad apple";
    exp.location = null;
    exp.location_details = new LocationDetails();
    exp.location_details.text = "Earth";
    exp.description = "Gigabad";
    profile_data.experiences.add(exp);
    Education edu = new Education();
    edu.start = "23/04/2014";
    edu.end = "12/06/2014";
    edu.title = "Some student boi";
    edu.school = "Bad apple school (yes)";
    edu.location = null;
    edu.location_details = new LocationDetails();
    edu.location_details.text = "Earth";
    edu.description = "Gigabad";
    profile_data.educations.add(edu);
    profile_data.skills.add("cooking");
    profile_data.skills.add("relatonship");
    profile_data.skills.add("c++");
    profile_data.languages.add("french");
    profile_data.languages.add("english");
    profile_data.interests.add("harder");
    profile_data.interests.add("faster");
    profile_data.interests.add("better");
    profile_data.interests.add("stronger");

    
    Map<String, Token> data = client.Profile().Json().check(profile_data, training_metadatas);
    System.out.println(data.get("name").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')

training_metadata = [
    {
        "filter_reference" => "reference0",
        "stage" => "NO",
        "stage_timestamp" => "1536619600",
        "rating" => "1",
        "rating_timestamp" => "1536619600"
    },
    {
        "filter_reference" => "reference1",
        "stage" => "YES",
        "stage_timestamp" => "1536619600",
        "rating" => "4",
        "rating_timestamp" => "1536619600"
    }
]
profile_data = {
            "name" => 'Magalie Desktest',
            "email" => 'magalie.desktest@gmail.com',
            "phone" => '+33743457894',
            "summary" => 'I the world greatest philosopher',
            "location_details" => {
                "text" => "Moon"
            },
            "experiences" => [
                {
                    "start" => "23/05/2010",
                    "end" => "",
                    "title" => "The Philosopher",
                    "company" => "Moon thinker",
                    "location" => nil,
                    "location_details" => {
                        "text" => "Moon"
                    },
                    "description" => "Chief of all philosophers"
                }
            ],
            "educations" => [
                {
                    "start" => "23/05/2005",
                    "end" => "2/04/2010",
                    "title" => "Philosophy",
                    "school" => "Moon school",
                    "location" => nil,
                    "location_details" => {
                        "text" => "Moon"
                    },
                    "description" => ""
                }
            ],
            "skills" => ["diplomacy", "Politics", "speech"],
            "languages" => ["english", "chinese", "french", "Swedish"],
            "interests" => ["jumping", "speaking", "video games", "sports"],
            "urls" => {
                "from_resume" => [],
                "linkedin" => nil,
                "twitter" => nil,
                "facebook" => nil,
                "github" => nil,
                "picture" => nil
            }
        }

data = client.profile.json.check "profile_json" => profile_data,
 "training_metadata" => training_metadata

puts(data)
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {

	client := riminder.New("api_key")

	trainingMetadata := []map[string]string{
		{
			"filter_reference": "reference0",
			"stage":            "NO",
			"stage_timestamp":  "1536619600",
			"rating":           "1",
			"rating_timestamp": "1536619600",
		},
		{
			"filter_reference": "reference1",
			"stage":            "YES",
			"stage_timestamp":  "1536619600",
			"rating":           "4",
			"rating_timestamp": "1536619600",
		},
	}
	profileData := map[string]interface{}{
		"name":    "Magalie Desktest",
		"email":   "magalie.desktest@gmail.com",
		"phone":   "+33743457894",
		"summary": "I the world greatest philosopher",
		"location_details": map[string]string{
			"text": "Moon",
		},
		"experiences": []map[string]interface{}{
			{
				"start":    "23/05/2010",
				"end":      "",
				"title":    "The Philosopher",
				"company":  "Moon thinker",
				"location": nil,
				"location_details": map[string]string{
					"text": "Moon",
				},
				"description": "Chief of all philosophers",
			},
		},
		"educations": []map[string]interface{}{
			{
				"start":    "23/05/2005",
				"end":      "2/04/2010",
				"title":    "Philosophy",
				"school":   "Moon school",
				"location": nil,
				"location_details": map[string]string{
					"text": "Moon",
				},
				"description": "",
			},
		},
		"skills":    []string{"diplomacy", "Politics", "speech"},
		"languages": []string{"english", "chinese", "french", "Swedish"},
		"interests": []string{"jumping", "speaking", "video games", "sports"},
		"urls": map[string]interface{}{
			"from_resume": []string{},
			"linkedin":    nil,
			"twitter":     nil,
			"facebook":    nil,
			"github":      nil,
			"picture":     nil,
		},
	}

	data, _ := client.Profile().JSON().Check(map[string]interface{}{"profile_json": profileData, "training_metadata": trainingMetadata})

	fmt.Println(data.ProfileJSON)
}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": {
    "profile_json": {..},
    "training_metadata": [..],
  }
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Body Params

profile_json
object

profile parsed data

 
training_metadata
array of objects

list of training metadata associated with different filters

filter_reference
stage
stage_timestamp
rating
rating_timestamp
 

Reponse

Field
Type
Description

profile_json

object

json of the checked profile.

training_metadata

object

Training metadata of the checked profile.

Document type

The document will be attached to source only if our backend identified it as a "resume".

profile_json example

{
    "name": "Test Persona",
    "email": "testperson@gmail.com",
    "address": "1 rue de test",
    "profile_reference": "reference0",
    "timestamp_reception": 1593870932,
    "experiences": [
      {
        "start": "15/02/2018",
        "end": "1/06/2018",
        "title": "PDG",
        "company": "Test Corp",
        "location": "Paris",
        "description": "Leading the company"
      }
    ],
    "educations": [
      {
        "start": "2000",
        "end": "2018",
        "title": "Diplome d'ingénieur",
        "school": "UTT",
        "description": "Management des systèmes d'information",
        "location": "Paris"
      }
    ],
    "skills": [
      "manual skill",
      "Creative spirit",
      "Writing skills",
      "Communication",
      "Project management",
      "French",
      "German",
      "Korean",
      "English",
      "Accounting",
      "Human resources"
    ]
  }

training_metadata example

[
  {
    "filter_reference": "reference0",
    "stage": null,
    "stage_timestamp": null,
    "rating": 2,
    "rating_timestamp": 1530607434
  },
  {
    "filter_reference": "reference1",
    "stage": null,
    "stage_timestamp": null,
    "rating": 2,
    "rating_timestamp": 1530607434
  }
]
Suggest Edits

/profile/json

Add a parsed resume to a sourced id

 

Header Auth

 Authentication is required for this endpoint.
posthttps://www.riminder.net/sf/public/api/v1.0/profile/json
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const data = {
  source_id: "source_id",
  profile_reference: "macfly",
  profile_json: {
    name: "Marty McFly",
    email: "marty.mcfly@gmail.com",
    phone: "202-555-0141",
    summary: "High school student, loves to time travel",
    timestamp_reception: new Date("1985-10-21"),
    location_details: {
      text: "9303 Lyon Drive, Lyon Estates, Hill Valley CA 95420"
    },
    experiences: [{
      start: "01/01/2017",
      end: "01/01/2018",
      title: "CusCo employee",
      company: "CusCo",
      location_details: {
        text: "Hill Valley"
      },
      location: "Hill Valley",
      description: "Fujitsu company"
    }],
    educations: [{
      start: "01/01/1985",
      end: "01/01/1986",
      title: "Hill Valley High School",
      school: "Hill Valley High School",
      location_details: {
        text: "Hill Valley"
      },
      location: "Hill Valley",
      description: "a school"
    }],
    skills: [
      "skate",
      "time travel"
    ],
    languages: [
      "english"
    ],
    interests: [
      "music",
    ],
    urls: {
      from_resume: [
        "test.com"
      ],
      linkedin: "",
      twitter: "",
      facebook: "",
      github: "",
      picture: ""
    }
  }
};

app.profile.json.add(data).then(data => {
  // Your treatment here
});
import riminder 

client = riminder.Riminder('api_key')
profile_data = {
            "name": "Hari Seldon",
            "email": "harisledon@trantor.trt",
            "address": "1 rue streeling",
            "experiences": [
              {
                "start": "15/02/12600",
                "end": "",
                "title": "Lead",
                "company": "Departement de la psychohistoire",
                "location": "Trator",
                "description": "Developping psychohistoire."
              }
            ],
            "educations": [
              {
                "start": "12540",
                "end": "12550",
                "title": "Diplome d'ingénieur mathematicien",
                "school": "Université de Hélicon",
                "description": "Etude des mathematique",
                "location": "Hélicon"
              }
            ],
            "skills": [
              "manual skill",
              "Creative spirit",
              "Writing skills",
              "Communication",
              "Project management",
              "French",
              "German",
              "Korean",
              "English",
              "Esquive",
              "Research",
              "Mathematique"
            ]
          }
profile_reference = "reference0"
timestamp_reception = 1593870932

resp = client.profile.json.add(source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                               profile_data=profile_data,
                               profile_reference=profile_reference,
                               timestamp_reception=timestamp_reception)

print(resp['data']['profile_json']['name'])
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');
	$profileData = [
            "name" => "Hari Seldon",
            "email" => "harisledon@trantor.trt",
            "address" => "1 rue streeling",
            "experiences" => [
              [
                "start" => "15/02/12600",
                "end" => "",
                "title" => "Lead",
                "company" => "Departement de la psychohistoire",
                "location" => "Trator",
                "description" => "Developping psychohistoire."
              ]
            ],
            "educations" => [
              [
                "start" => "12540",
                "end" => "12550",
                "title" => "Diplome d'ingénieur mathematicien",
                "school" => "Université de Hélicon",
                "description" => "Etude des mathematique",
                "location" => "Hélicon"
              ]
            ],
            "skills" => [
              "manual skill",
              "Creative spirit",
              "Writing skills",
              "Communication",
              "Project management",
              "French",
              "German",
              "Korean",
              "English",
              "Esquive",
              "Research",
              "Mathematique"
            ]
          ];
  $source_id =  "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
	$profile_reference = "49583";
	$training_metadata = [];
	$data = $client->profile->data->check($source_id, $profileData, $training_metadata,
                                        $profile_reference);
	print($data['profile_json']['name']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile/json" \
--request POST \
--data "{ \
    \"source_id\": \"source_id\", \
    \"profile_reference\": \"macfly\", \
    \"profile_json\": { \
        \"name\": \"Marty McFly\", \
        \"email\": \"marty.mcfly@gmail.com\", \
        \"phone\": \"202-555-0141\", \
        \"summary\": \"High school student, loves to time travel\", \
        \"timestamp_reception\": \"1985-10-21T00:00:00.000Z\", \
        \"location_details\": { \
            \"text\": \"9303 Lyon Drive, Lyon Estates, Hill Valley CA 95420\" \
        }, \
        \"experiences\": [ \
            { \
                \"start\": \"01/01/2017\", \
                \"end\": \"01/01/2018\", \
                \"title\": \"CusCo employee\", \
                \"company\": \"CusCo\", \
                \"location_details\": { \
                    \"text\": \"Hill Valley\" \
                }, \
                \"location\": \"Hill Valley\", \
                \"description\": \"Fujitsu company\" \
            } \
        ], \
        \"educations\": [ \
            { \
                \"start\": \"01/01/1985\", \
                \"end\": \"01/01/1986\", \
                \"title\": \"Hill Valley High School\", \
                \"school\": \"Hill Valley High School\", \
                \"location_details\": { \
                    \"text\": \"Hill Valley\" \
                }, \
                \"location\": \"Hill Valley\", \
                \"description\": \"a school\" \
            } \
        ], \
        \"skills\": [ \
            \"skate\", \
            \"time travel\" \
        ], \
        \"languages\": [ \
            \"english\" \
        ], \
        \"interests\": [ \
            \"music\" \
        ], \
        \"urls\": { \
            \"from_resume\": [ \
                \"test.com\" \
            ], \
            \"linkedin\": \"\", \
            \"twitter\": \"\", \
            \"facebook\": \"\", \
            \"github\": \"\", \
            \"picture\": \"\" \
        } \
    } \
}" --header "X-API-KEY: api_key"
using System;
using Riminder;

// for TrainingMetadatas
using Riminder.response;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "34t4e981cd232l6f5c549eegh1a7554db0d2256y";
    var profile_reference = "49583";
    var timestamp_reception = "1495727300";
    var profileData = new Riminder.response.ProfileJson()
            {
                name = "Salvar Hardon",
                email = "sssalvorrr.54haaardiiin@gmail.com",
                phone = "0678524695",
                summary = "Former mayor of Terminuis I resolve one of the first Sheldon Crisis.",
                location_details = new Riminder.response.ProfileJson.LocationDetails()
                {
                    text = "Terminus, Terminuis"
                },
                experiences = new List<Riminder.response.ProfileJson.Experience>()
                {
                    {new Riminder.response.ProfileJson.Experience
                    {
                        start = "21/1/45",
                        end = "12/12/55",
                        title = "Mayor",
                        company = "Fondations",
                        location = null,
                        location_details = new Riminder.response.ProfileJson.LocationDetails()
                        {
                            text = "Terminus, Terminus"
                        },
                        description = "Save the Fondation."
                    }}
                },
                educations = new List<Riminder.response.ProfileJson.Education>()
                {
                    {new Riminder.response.ProfileJson.Education
                    {
                        start = "21/1/30",
                        end = "12/12/40",
                        title = "something",
                        school = "Fondation hard school",
                        location = null,
                        location_details = new Riminder.response.ProfileJson.LocationDetails()
                        {
                            text = "Terminus, Terminuis"
                        },
                        description = "..."
                    }}
                },
                skills = new List<string>()
                {
                    "diplomacy", "Politics", "Future Science", "Flight"
                },
                languages = new List<string>()
                {
                    "English"
                },
                interests = new List<string>()
                {
                    "cigor", "Fondation"
                },
                urls = new Riminder.response.ProfileJson.Urls()
                {
                    from_resume = new List<string>(),
                    linkedin = null,
                }
                
            };
    var training_metadata = new TrainingMetadatas()
    {
      {new TrainingMetadata()
        {
          filter_reference = "12345",
          stage = "YES",
          stage_timestamp = 1527263300,
          rating = 4,
          rating_timestamp = 1527263300
        }
      },
      {new TrainingMetadata()
        {
          filter_reference = "54321",
          stage = "N0",
          stage_timestamp = 1527263300,
          rating = 1,
          rating_timestamp = 1527263300
        }
      },
    }

    var data = client.json.add(source_id, profileData, profile_reference,
                               timestamp_reception, training_metadata);
    Console.WriteLine(data.profile_json.name);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.route.Profile.TrainingMetadata;
import net.riminder.riminder.route.Profile.Json.Education;
import net.riminder.riminder.route.Profile.Json.Experience;
import net.riminder.riminder.route.Profile.Json.LocationDetails;
import net.riminder.riminder.route.Profile.Json.ProfileJson;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    String source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    String file_path = "path/to/file";
    String profile_reference = "49583";
    Long timestamp_reception = 1534868230;
    List<TrainingMetadata> training_metadatas = new ArrayList<>();
    TrainingMetadata trainingMetadata = new TrainingMetadata();
    trainingMetadata.filter_reference = "reference0";
    trainingMetadata.rating = 3;
    trainingMetadata.rating_timestamp = 1534868230;
    trainingMetadata.stage = Constants.Stage.LATER;
    trainingMetadata.stage_timestamp = 1534868230;
   	training_metadatas.add(trainingMetadata);
    
    ProfileJson profile_data = new ProfileJson();
    profile_data.name = "Love Lover";
    profile_data.email = "Lovelover@gmail.com";
    profile_data.phone = "+3369895421";
    profile_data.summary = "Les loeleleeleeldkffkjfjfffkfkffffkf.";
    profile_data.locationDetails.text = "Mars, sector 7, 45e Cadran";
    Experience exp = new Experience();
    exp.start = "23/04/2015";
    exp.end = "12/06/2015";
    exp.title = "Some guy";
    exp.company = "Bad apple";
    exp.location = null;
    exp.location_details = new LocationDetails();
    exp.location_details.text = "Earth";
    exp.description = "Gigabad";
    profile_data.experiences.add(exp);
    Education edu = new Education();
    edu.start = "23/04/2014";
    edu.end = "12/06/2014";
    edu.title = "Some student boi";
    edu.school = "Bad apple school (yes)";
    edu.location = null;
    edu.location_details = new LocationDetails();
    edu.location_details.text = "Earth";
    edu.description = "Gigabad";
    profile_data.educations.add(edu);
    profile_data.skills.add("cooking");
    profile_data.skills.add("relatonship");
    profile_data.skills.add("c++");
    profile_data.languages.add("french");
    profile_data.languages.add("english");
    profile_data.interests.add("harder");
    profile_data.interests.add("faster");
    profile_data.interests.add("better");
    profile_data.interests.add("stronger");

    
    Map<String, Token> data = client.Profile().Json().add(source_id, profile_data, profile_reference, timestamp_reception, training_metadatas);
    System.out.println(data.get("name").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')

training_metadata = [
    {
        "filter_reference" => "reference0",
        "stage" => "NO",
        "stage_timestamp" => "1536619600",
        "rating" => "1",
        "rating_timestamp" => "1536619600"
    },
    {
        "filter_reference" => "reference1",
        "stage" => "YES",
        "stage_timestamp" => "1536619600",
        "rating" => "4",
        "rating_timestamp" => "1536619600"
    }
]
profile_data = {
            "name" => 'Magalie Desktest',
            "email" => 'magalie.desktest@gmail.com',
            "phone" => '+33743457894',
            "summary" => 'I the world greatest philosopher',
            "location_details" => {
                "text" => "Moon"
            },
            "experiences" => [
                {
                    "start" => "23/05/2010",
                    "end" => "",
                    "title" => "The Philosopher",
                    "company" => "Moon thinker",
                    "location" => nil,
                    "location_details" => {
                        "text" => "Moon"
                    },
                    "description" => "Chief of all philosophers"
                }
            ],
            "educations" => [
                {
                    "start" => "23/05/2005",
                    "end" => "2/04/2010",
                    "title" => "Philosophy",
                    "school" => "Moon school",
                    "location" => nil,
                    "location_details" => {
                        "text" => "Moon"
                    },
                    "description" => ""
                }
            ],
            "skills" => ["diplomacy", "Politics", "speech"],
            "languages" => ["english", "chinese", "french", "Swedish"],
            "interests" => ["jumping", "speaking", "video games", "sports"],
            "urls" => {
                "from_resume" => [],
                "linkedin" => nil,
                "twitter" => nil,
                "facebook" => nil,
                "github" => nil,
                "picture" => nil
            }
        }
source_id = "4594e981cd23d16f5c549eea21a7554db0c92745"
profile_reference = "49583"
timestamp_reception = 1527263300

data = client.profile.json.add "source_id" => source_id, 
    "profile_json" => profile_data, "profile_reference" => profile_reference,
    "timestamp_reception" => timestamp_reception, "training_metadata" => training_metadata

puts(data['profile_reference'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {

	client := riminder.New("api_key")

	trainingMetadata := []map[string]string{
		{
			"filter_reference": "reference0",
			"stage":            "NO",
			"stage_timestamp":  "1536619600",
			"rating":           "1",
			"rating_timestamp": "1536619600",
		},
		{
			"filter_reference": "reference1",
			"stage":            "YES",
			"stage_timestamp":  "1536619600",
			"rating":           "4",
			"rating_timestamp": "1536619600",
		},
	}
	profileData := map[string]interface{}{
		"name":    "Magalie Desktest",
		"email":   "magalie.desktest@gmail.com",
		"phone":   "+33743457894",
		"summary": "I the world greatest philosopher",
		"location_details": map[string]string{
			"text": "Moon",
		},
		"experiences": []map[string]interface{}{
			{
				"start":    "23/05/2010",
				"end":      "",
				"title":    "The Philosopher",
				"company":  "Moon thinker",
				"location": nil,
				"location_details": map[string]string{
					"text": "Moon",
				},
				"description": "Chief of all philosophers",
			},
		},
		"educations": []map[string]interface{}{
			{
				"start":    "23/05/2005",
				"end":      "2/04/2010",
				"title":    "Philosophy",
				"school":   "Moon school",
				"location": nil,
				"location_details": map[string]string{
					"text": "Moon",
				},
				"description": "",// package main
			},
		},
		"skills":    []string{"diplomacy", "Politics", "speech"},
		"languages": []string{"english", "chinese", "french", "Swedish"},
		"interests": []string{"jumping", "speaking", "video games", "sports"},
		"urls": map[string]interface{}{
			"from_resume": []string{},
			"linkedin":    nil,
			"twitter":     nil,
			"facebook":    nil,
			"github":      nil,
			"picture":     nil,
		},
	}
	sourceID := "4594e981cd23d16f5c549eea21a7554db0c92745"
	profileReference := "49583"
	timestampReception := 1527263300

	data, _ := client.Profile().JSON().Add(map[string]interface{}{"source_id": sourceID,
		"profile_json": profileData, "profile_reference": profileReference,
		"timestamp_reception": timestampReception, "training_metadata": trainingMetadata})

	fmt.Println(data.ProfileID)
}
A binary file was returned

You couldn't be authenticated

{
  "code": 201,
  "message": "ok",
  "data": {
    "source_id":"102b6aa635fnf8ar70e7888ee63c0jde0c753dtg",
    "profile_reference":"49583",
    "profile_json":{..},
    "date_reception": {
      "date": "2017-05-25 17:48:20.000000",
      "timezone_type": 3,
      "timezone": "Europe/Paris"
     }, 
     "training_metadata":[..],
  }
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Body Params

source_id
string
required

source id

profile_json
object
required

profile parsed data

 
profile_reference
string

reference to assign to the profile

timestamp_reception
date-time

original date of the application of the profile.

training_metadata
object

list of training metadata associated with different filters

 
 

Reponse

Field
Type
Description

profile_id

string

profile id.

source_id

string

source id.

profile_json

object

Data of the checked profile.

training_metadata

object list

Training metadata of the checked profile.

Document type

The document will be attached to source only if our backend identified it as a "resume".

profile_json example

{
    "name": "Test Persona",
    "email": "testperson@gmail.com",
    "address": "1 rue de test",
    "profile_reference": "reference0",
    "timestamp_reception": 1593870932,
    "experiences": [
      {
        "start": "15/02/2018",
        "end": "1/06/2018",
        "title": "PDG",
        "company": "Test Corp",
        "location": "Paris",
        "description": "Leading the company"
      }
    ],
    "educations": [
      {
        "start": "2000",
        "end": "2018",
        "title": "Diplome d'ingénieur",
        "school": "UTT",
        "description": "Management des systèmes d'information",
        "location": "Paris"
      }
    ],
    "skills": [
      "manual skill",
      "Creative spirit",
      "Writing skills",
      "Communication",
      "Project management",
      "French",
      "German",
      "Korean",
      "English",
      "Accounting",
      "Human resources"
    ]
  }

training_metadata example

[
  {
    "filter_reference": "reference0",
    "stage": null,
    "stage_timestamp": null,
    "rating": 2,
    "rating_timestamp": 1530607434
  },
  {
    "filter_reference": "reference1",
    "stage": null,
    "stage_timestamp": null,
    "rating": 2,
    "rating_timestamp": 1530607434
  }
]
Suggest Edits

/profiles

Retrieve the profile information associated with profile id

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/profiles
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  source_ids: ["source1", "source2"],
  date_start: Date.now(),
  date_end: new Date("2018-01-01"),
  page: 1,
  filter_id: "filter_id",
  // Or
  filter_reference: "filter_reference",
  stage: Stage.YES,
  rating: 2,
  limit: 20,
  sort_by: SortBy.RANKING,
  order_by: OrderBy.ASC
}

app.profile.list(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');
	$options = [
    'source_ids' => ['4a7f12f541f38d775cd010f785b1c836f46e85a9'],
    'seniority' => 'ALL',
    'filter_id' => '6op812f541f38d775cd010f785b1c836f46e45lo',
    'stage' => 'NO',
    'rating' => '2',
    'date_start' => '1494539999',
    'date_end' => '1494539999',
    'page' => 1,
    'limit' => 20,
    'sort_by' => 'ranking',
    'order_by' => 'asc'
	];

	$data = $client->profile->list($options);
	print($data['profiles'][0]['profile_id']);

	$date_end = new DateTime();
	$options = [
    'source_ids' => ['4a7f12f541f38d775cd010f785b1c836f46e85a9'],
    'date_start' => '1494539999',
    'date_end' => $date_end->getTimestamp(),
    'sort_by' => 'ranking',
    'filter_reference' => 'reference0',
	];

	$data = $client->profile->list($options);
	print($data['profiles'][0]['profile_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profiles?source_ids=%5B%22source1%22,%22source2%22%5D&date_start=149453999&date_end=1502488799&filter_id=filter_id&sort_by=ranking&stage=YES" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')

resp = client.profile.list(source_ids=['215de6cb5099f4895149ec0a6ac91be94ffdd246',
                                       '6386f54e6009b1b976d1a24935191edce20f0817'])
print(resp['profiles'][0]['profile_id'])

resp = client.profile.list(source_ids=['215de6cb5099f4895149ec0a6ac91be94ffdd246',
                                       '6386f54e6009b1b976d1a24935191edce20f0817'], 
                           seniority="all", 
                           stage=None, 
                           date_start="1494539999", 
                           date_end=TIMESTAMP_NOW, 
                           filter_id=None,
                           page=1,
                           limit=30,
                           sort_by='ranking', 
                           filter_reference=None, 
                           order_by=None)
print(resp['data']['profiles'][0]['profile_id'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_ids = List<string>() 
    {
      {"4a7f12f541f38d775cd010f785b1c836f46e85a9"},	{"042d499d4e98c4b2aa669a86e044484ed2d57939"}
    };
    var date_start = "1274802500";
    var date_end = "1527263300";
    var page = 1;
    var limit = 45;
    var seniority = "all";
    var filter_reference = "referenc0";
    var stage = "NEW";
    var rating = 1;
    var sort_by = "RANKING";
    var order_by = "ASC";
    
    var data0 = client.profile.list(source_ids, date_start, date_end);
    Console.WriteLine(data0.profiles[0].name);
    
    var data1 = client.profile.list(source_ids, date_start, date_end,
                                    page: page,
                                    limit: limit,
                                    seniority: seniority,
                                    filter_reference: filter_reference,
                                    stage: stage,
                                    rating: rating,
                                    sort_by: sort_by,
                                    order_by: order_by);
   	Console.WriteLine(data1.profiles[0].name);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.Constants;
import net.riminder.riminder.route.Profile.Listoptions;
import net.riminder.riminder.response.Token;
import java.util.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    Listoptions listoptions = new Listoptions();
        listoptions.source_ids.add("4a7f12f541f38d775cd010f785b1c836f46e85a9");
        listoptions.seniority = Constants.Seniority.JUNIOR;
        listoptions.date_end = new Long(1534868230);
        listoptions.date_start = new Long(1503305283);
        listoptions.page = 2;
        listoptions.limit = 2;
        listoptions.sort_by = Constants.SortBy.RECEPTION;
        listoptions.order_by = Constants.OrderBy.DESC;
        listoptions.filter_reference = "reference0";
        listoptions.stage = Constants.Stage.NEW;
        listoptions.rating = 1;
    
    Map<String, Token> data = client.Profile().list(listoptions);
    System.out.println(data.get("profiles").asList().get(0).asMap().get("name").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')

source_ids = ["6386f54e6009b1b976d1a24935191edce20f0817", "215de6cb5099f4895149ec0a6ac91be94ffdd246"]
date_start = "1274802500";
date_end = "1527263300";
page = 1;
limit = 45;
seniority = "all";
filter_reference = "referenc0";
stage = "NEW";
rating = 1;
sort_by = "RANKING";
order_by = "ASC";

data0 = client.profile.list "source_ids" => source_ids
puts(data0['profiles'][0])

data1 = client.profile.list "source_ids" => source_ids, 
    "date_start" => date_start, 
    "date_end" => date_end, 
    "page" => page,
    "limit" => limit,
    "seniority" => seniority,
    "filter_reference" => filter_reference,
    "stage" => stage,
    "rating" => rating,
    "sort_by" => sort_by,
    "order_by" => order_by
puts(data1['profiles'][0])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {

	client := riminder.New("api_key")

	sourceIDs := []string{"6386f54e6009b1b976d1a24935191edce20f0817", "215de6cb5099f4895149ec0a6ac91be94ffdd246"}
	dateStart := "1274802500"
	dateEnd := "1527263300"
	page := 1
	limit := 45
	seniority := "all"
	filterReference := "referenc0"
	stage := "NEW"
	rating := 1
	sortBy := "RANKING"
	orderBy := "ASC"

	data0, _ := client.Profile().List(map[string]interface{}{"source_ids": sourceIDs})
	fmt.Println(data0.Profiles[0])

	data1, _ := client.Profile().List(map[string]interface{}{"source_ids": sourceIDs,
		"date_start":       dateStart,
		"date_end":         dateEnd,
		"page":             page,
		"limit":            limit,
		"seniority":        seniority,
		"filter_reference": filterReference,
		"stage":            stage,
		"rating":           rating,
		"sort_by":          sortBy,
		"order_by":         orderBy})
	fmt.Println(data1.Profiles[0])
}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "OK",
  "data": {
    "page": 1,
    "maxPage": 3,
    "count_profiles": 85,
    "profiles": [
      {
        "profile_id": "215de6cb5099f4895149ec0a6ac91be94ffdd246",
        "profile_reference": "49583",
        "name": null,
        "email": "daenerys.targaryen@dragonstone.com",
        "date_reception": {
          "date": "2017-08-01 16:33:24.000000",
          "timezone_type": 3,
          "timezone": "Europe/Paris"
        },
        "date_creation": {
          "date": "2017-08-07 19:46:48.000000",
          "timezone_type": 3,
          "timezone": "Europe/Paris"
        },
        "source": {
          "source_id": "4a7f12f541f38d775cd010f785b1c836f46e85a9",
          "name": "dragonstone",
          "type": "folder"
        },
        "score": 0.89999110102654,
        "stage": "YES",
        "rating": 4
      },
      {
        "profile_id": "6386f54e6009b1b976d1a24935191edce20f0817",
        "profile_reference": "39503",
        "name": "Cersei Lannister",
        "email": "cersei.lannister@kingslanding.com",
        "seniority": "senior",
        "date_reception": {
          "date": "2017-05-25 17:48:20.000000",
          "timezone_type": 3,
          "timezone": "Europe/Paris"
        },
        "date_creation": {
          "date": "2017-05-25 17:48:24.000000",
          "timezone_type": 3,
          "timezone": "Europe/Paris"
        },
        "source": {
          "source_id": "042d499d4e98c4b2aa669a86e044484ed2d57939",
          "name": "castle rock",
          "type": "campaign"
        },
        "score": 0.63059716820717
        "stage": "YES",
        "rating": 2
 			}
    ]
  }
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Query Params

source_ids
array of strings
required

array of source ids

filter_id
string

filter id.

filter_reference
string

filter reference.

stage
string

profiles' stage associated to the filter ( null for all, NEW, YES, LATER or NO).

rating
int32

profile rating from 1 to 4 associated to the filter.

date_start
date-time
required

profiles' first date of reception(the default value correspond to 01 May 2017 at 23:59:59)

date_end
date-time
required

profiles' last date of reception (the default value correspond to 11 August 2017 at 23:59:59)

page
int32
required

number of the page associated to the pagination

limit
int32

number of fetched profiles/page

sort_by
string

sort profiles by original date RECEPTION, RANKING associated to the job or null for date creation.

order_by
string

order profiles by DESC or ASC.

 

Reponse

Field
Type
Description

profile_id

string

profile id.

profile_reference

string

profile reference (customizable in the PROFILE API POST).

name

string

profile name (first name + last name ).

email

string

profile email.

date_reception

datetime

original date of the application of the profile.

date_creation

datetime

date of the creation of the profile.

source

object

source associated to the profile.

source.id

string

source id.

source.name

string

source name.

source.type

string

source type.

score

float

profile score associated to the filter.

stage

string

profile stage associated to the filter (YES,LATER,NO, NEW).

rating

integer

profile rating from 1 to 4 associated to the filter.

Suggest Edits

/profile

Retrieve the profile information associated with profile id and source_id.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/profile
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  source_id: "source_id",
  profile_id: "profile_id",
  // or
  profile_reference: "profile_reference",
}

app.profile.get(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');

	$profile_id = '7c14e981cd232l6f5c549eea21a7554db0d221a7';
	$source_id = '4c14e981cd232l6f5c549eea21a7554db0d221a7';

	$data = $client->profile->get(new ProfileID($profile_id), $source_id);
	print($data['profile_id']);

	$profile_reference = 'reference0';
	$data = $client->profile->get(new ProfileReference($profile_reference), $source_id);
	print($data['profile_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile?source_id=source_id&profile_id=profile_id" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')

resp = client.profile.get(profile_id='7c94e981cd23d16f5c549eea21a7554db0c927a7', source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7')
print(resp['data']['profile_id'])

resp = client.profile.get(profile_referrence='reference0', source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7')
print(resp['data']['profile_id'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "34t4e981cd232l6f5c549eegh1a7554db0d2256y";
    var profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    var profile_ref = "349593";
    
    // With id
    var data0 = client.profile.get(source_id, profile_id);
    Console.WriteLine(data0.name);
    
    // With reference
    var data1 = client.profile.get(source_id, profile_reference: profile_ref);
    Console.WriteLine(data1.name);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.Ident;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    String source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    String profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    String profile_reference = "refernce0";
    
    Map<String, Token> data0 = client.Profile().get(source_id, new Ident.ID(Ident.Profile, profile_id));
    System.out.println(data0.get("name").as());
    
    Map<String, Token> data1 = client.Profile().get(source_id, new Ident.Reference(Ident.Profile, profile_reference));
    System.out.println(data1.get("name").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')

source_id = "6386f54e6009b1b976d1a24935191edce20f0817"
profile_id = "4594e981cd23d16f5c549eea21a7554db0c92745"
profile_reference = "reference0"

data0 = client.profile.get "source_id" => source_id, "profile_id" => profile_id
puts(data0['name'])
data1 = client.profile.get "source_id" => source_id, "profile_reference" => profile_reference
puts(data1['name'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")

	sourceID := "6386f54e6009b1b976d1a24935191edce20f0817"
	profileID := "4594e981cd23d16f5c549eea21a7554db0c92745"
	profileReference := "reference0"

	data0, _ := client.Profile().Get(map[string]interface{}{"source_id": sourceID, "profile_id": profileID})
	fmt.Println(data0.Name)
  
	data1, _ := client.Profile().Get(map[string]interface{}{"source_id": sourceID, "profile_reference": profileReference})
	fmt.Println(data1.Name)

}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": {
    "profile_id": "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg",
    "profile_reference": "349593",
    "name": "John Snow",
    "email": "john.snow@winterfell.com",
    "phone": null,
    "address": null,
    "source_id": 141,
    "date_reception": {
      "date": "2017-08-10 18:46:23.000000",
      "timezone_type": 3,
      "timezone": "Europe/Paris"
    },
    "date_creation": {
      "date": "2017-08-10 18:47:21.000000",
      "timezone_type": 3,
      "timezone": "Europe/Paris"
    }
  }
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Query Params

source_id
string
required

source id associated to the profile.

profile_id
string

profile id.

profile_reference
string

profile reference.

 

Reponse

Field
Type
Description

profile_id

string

profile id.

profile_reference

string

profile reference (customizable in the PROFILE API POST).

name

string

profile name (first name + last name ).

email

string

profile email.

phone

string

profile phone.

address

string

profile address.

source_id

string

source id associated to the profile.

date_reception

datetime

original date of the application of the profile.

date_creation

datetime

date of the creation of the profile.

Suggest Edits

/profile/documents

Retrieve the profile documents associated with profile id and source_id.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/profile/documents
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  source_id: "source_id",
  profile_id: "profile_id",
  // or
  profile_reference: "profile_reference",
}

app.profile.document.list(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$riminderClient = new Riminder('api_key');

	$profile_id = '7c14e981cd232l6f5c549eea21a7554db0d221a7';
	$source_id = '4c14e981cd232l6f5c549eea21a7554db0d221a7';

	$data = $client->profile->document->list(new ProfileID($profile_id), $source_id);
	print(data['profile_id']);

	$profile_reference = 'reference0';
	$data = $client->profile->document->list(new ProfileReference($profile_reference),
                                           $source_id);
	print($data['profile_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile/documents?source_id=source_id&profile_id=profile_id" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')

resp = client.profile.document.list(profile_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                                    source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7')
print(resp['data'][0]['type'])

resp = client.profile.document.list(profile_referrence='reference0',
                                    source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7')
print(resp['data'][0]['type'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "34t4e981cd232l6f5c549eegh1a7554db0d2256y";
    var profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    var profile_ref = "349593";
    
    // With id
    var data0 = client.profile.document.list(source_id, profile_id);
    Console.WriteLine(data0[0].type);
    
    // With reference
    var data1 = client.profile.document.list(source_id, profile_reference: profile_ref);
    Console.WriteLine(data1[0].type);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.Ident;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    String source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    String profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    String profile_reference = "refernce0";
    
    Map<String, Token> data0 = client.Profile().Documents().list(source_id, new Ident.ID(Ident.Profile, profile_id));
    System.out.println(data0.get(0).getMap().get("type").as());
    
    Map<String, Token> data1 = client.Profile().Documents().list(source_id, new Ident.Reference(Ident.Profile, profile_reference));
    System.out.println(data0.get(0).getMap().get("type").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')

source_id = "6386f54e6009b1b976d1a24935191edce20f0817"
profile_id = "4594e981cd23d16f5c549eea21a7554db0c92745"
profile_reference = "reference0"

data0 = client.profile.document.list "source_id" => source_id, "profile_id" => profile_id
puts(data0[0]['type'])
data1 = client.profile.document.list "source_id" => source_id, "profile_reference" => profile_reference
puts(data1[0]['type'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")

	sourceID := "6386f54e6009b1b976d1a24935191edce20f0817"
	profileID := "4594e981cd23d16f5c549eea21a7554db0c92745"
	profileReference := "reference0"

	data0, _ := client.Profile().Document().List(map[string]interface{}{"source_id": sourceID, "profile_id": profileID})
	fmt.Println(data0[0].FileName)
  
	data1, _ := client.Profile().Document().List(map[string]interface{}{"source_id": sourceID, "profile_reference": profileReference})
	fmt.Println(data1[0].FileName)

}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": [
    {
      "type": "original",
      "file_name": "087Z24UAT3HA8HDUY4RUI.pdf",
      "original_file_name": "John SNOW from Winterfell.pdf",
      "file_size": 65212,
      "extension": "pdf",
      "url": "https://s3.amazonaws.com/riminder-documents/original/087Z24UAT3HA8HDUY4RUI.pdf",
      "timestamp": 15023120
    },
    {
      "type": "resume",
      "file_name": "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg.pdf",
      "original_file_name": "resume",
      "file_size": 88953,
      "extension": "pdf",
      "url": "https://s3.amazonaws.com/riminder-documents/resume/702b6aa665aff8ae70e7488ee63c0ade0c753dfd.pdf",
      "timestamp": 1502383641
    },
    {
      "type": "cover",
      "file_name": "da39a3ee5e6b4b0d3255bfef95601890afd80709.pdf",
      "original_file_name": "cover",
      "file_size": 88953,
      "extension": "pdf",
      "url": "https://s3.amazonaws.com/riminder-documents/resume/da39a3ee5e6b4b0d3255bfef95601890afd80709.pdf",
      "timestamp": 1502383641
    }
  ]
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Query Params

source_id
string
required

source id associated to the profile.

profile_id
string

profile id.

profile_reference
string

profile reference.

 

Reponse

Field
Type
Description

type

string

document type (original document, resume or cover letter if found).

file_name

string

document file name.

original_file_name

string

document original file name.

file_size

integer

document file size in bytes.

extension

string

document extension.

url

string

document public url.

timestamp

datetime

document timestamp (Europe/Paris).

source_id

string

source id associated to the profile.

Suggest Edits

/profile/parsing

Retrieve the profile parsing associated with profile id and source_id.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/profile/parsing
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  source_id: "source_id",
  profile_id: "profile_id",
  // or
  profile_reference: "profile_reference",
}

app.profile.parsing.get(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');

	$profile_id = '7c14e981cd232l6f5c549eea21a7554db0d221a7';
	$source_id = '4c14e981cd232l6f5c549eea21a7554db0d221a7';

	$data = $client->profile->parsing->get(new ProfileID($profile_id), $source_id);
	print($data['profile_id']);

	$profile_reference = 'reference0';
	$data = $client->profile->parsing->get(new ProfileReference($profile_reference),
                                         $source_id);
	print($data['profile_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile/parsing?source_id=source_id&profile_id=profile_id" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')

resp = client.profile.parsing.get(profile_id='7c94e981cd23d16f5c549eea21a7554db0c927a7', source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7')
print(resp['data']['hard_skills'])

resp = client.profile.parsing.get(profile_referrence='reference0', source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7')
print(resp['data']['hard_skills'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "34t4e981cd232l6f5c549eegh1a7554db0d2256y";
    var profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    var profile_ref = "349593";
    
    // With id
    var data0 = client.profile.parsing.get(source_id, profile_id);
    Console.WriteLine(data0.seniority);
    
    // With reference
    var data1 = client.profile.parsing.get(source_id, profile_reference: profile_ref);
    Console.WriteLine(data1.seniority);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.Ident;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    String source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    String profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    String profile_reference = "refernce0";
    
    Map<String, Token> data0 = client.Profile().Parsing().get(source_id, new Ident.ID(Ident.Profile, profile_id));
    System.out.println(data0.get("seniority").as());
    
    Map<String, Token> data1 = client.Profile().Parsing().get(source_id, new Ident.Reference(Ident.Profile, profile_reference));
    System.out.println(data1.get("seniority").as());
  }
require 'riminder'

client = Riminder.new('api_key')

source_id = "6386f54e6009b1b976d1a24935191edce20f0817"
profile_id = "4594e981cd23d16f5c549eea21a7554db0c92745"
profile_reference = "reference0"

data0 = client.profile.parsing.get "source_id" => source_id, "profile_id" => profile_id
puts(data0['seniority'])
data1 = client.profile.parsing.get "source_id" => source_id, "profile_reference" => profile_reference
puts(data1['seniority'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")

	sourceID := "6386f54e6009b1b976d1a24935191edce20f0817"
	profileID := "4594e981cd23d16f5c549eea21a7554db0c92745"
	profileReference := "reference0"

	data0, _ := client.Profile().Parsing().Get(map[string]interface{}{"source_id": sourceID, "profile_id": profileID})
	fmt.Println(data0.HardSkills)
  
	data1, _ := client.Profile().Parsing().Get(map[string]interface{}{"source_id": sourceID, "profile_reference": profileReference})
	fmt.Println(data1.HardSkills)

}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": {
    "hard_skills": [
      "big data",
      "project management",
      "machine learning",
      "optimization",
      "web marketing",
      "python",
      "business intelligence",
      "r programming",
      "mvc architecture"
    ],
    "soft_skills": [
      "start-up ventures",
      "applied mathematics",
      "entrepreneurship education",
      "data science",
      "social entrepreneurship",
      "competitive marketing strategies"
    ],
    "languages": ["Arabic", "French", "English", "Japanese"],
    "experiences": [
      {
        "title": "Visiting Assistant Professor",
        "description": "Text Mining, Deep Learning for NLP and Recommandations Systems for last year engineering degree students in Computer Science and Advanced systems",
        "company": "Ecole Centrale Paris",
        "location": "Île-de-France, France",
        "start_date": "1451606400",
        "end_date": "1500992131"
      },
      {
        "title": "Founder & CEO",
        "description": "Riminder is the most advanced AI recruiter's assistant that automates talent assessment. We automates resumes and video interviews screening by leveraging state of the art Deep Learning.We are on a mission to reveal people’s full potential",
        "company": "Riminder",
        "location": "Île-de-France, France",
        "start_date": "1377993600",
        "end_date": "1500992131"
      },
      {
        "title": "Co-founder & Chief Technology Officer",
        "description": "Launch of an African soft beverage brand « Biss».",
        "company": "Biss",
        "location": "Île-de-France, France",
        "start_date": "1356998400",
        "end_date": "1377993600"
      }
    ],
    "educations": [
      {
        "title": "Master's degree in research in Applied Mathematics, Machine learning, Artificial intelligence, Statistical Learning, Computer Vision and Data Mining",
        "description": "The master's degree \"MVA\", based in the Department of Mathematics at the Ecole Normale Supérieure, forms dozens of students from the french Grandes Ecoles to careers in public and private research in the field of applied mathematics, among other things, statistical learning.",
        "school": "Ecole normale supérieure",
        "location": "Paris, France",
        "start_date": "1388534400",
        "end_date": "1420070400"
      },
      {
        "title": "Engineering Degree & Master of Science, Theoretical and Mathematical Physics,Mathematics and Computer Science",
        "description": "",
        "school": "Ecole centrale de Paris / Centrale Paris",
        "location": "Paris, France",
        "start_date": "1293840000",
        "end_date": "1388534400"
      }
    ]
  }
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 401,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Query Params

source_id
string
required

source id associated to the profile.

profile_id
string

profile id.

profile_reference
string

profile reference.

 

Reponse

Field
Type
Description

hard_skills

array

profile hard skills.

soft_skills

array

profile soft skills.

languages

array

profile languages.

experiences

array

profile work experiences.

experiences[].title

string

experience title.

experiences[].description

string

experience description.

experiences[].company

string

experience company name.

experiences[].location

string

experience location.

experiences[].start_date

timestamp

experience start date (Europe/Paris)..

experiences[].end_dat

timestamp

experience end date (Europe/Paris)..

educations

array

profile educations.

educations[].title

string

education title.

educations[].description

string

education description.

educations[].school

string

education school name.

educations[].location

string

education location (City, Country.

educations[].start_date

timestamp

education start date (Europe/Paris)..

educations[].end_dat

timestamp

education end date (Europe/Paris)..

date_reception

datetime

original date of the application of the profile.

date_creation

datetime

date of the creation of the profile.

source_id

string

source id associated to the profile.

Suggest Edits

/profile/scoring

Retrieve the profile scoring associated with profile id and source_id.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/profile/scoring
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  source_id: "source_id",
  profile_id: "profile_id",
  // or
  profile_reference: "profile_reference",
}

app.profile.scoring.list(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');

	$profile_id = '7c14e981cd232l6f5c549eea21a7554db0d221a7';
	$source_id = '4c14e981cd232l6f5c549eea21a7554db0d221a7';

	$data = $client->profile->scoring->list(new ProfileID($profile_id), $source_id);
	print(data['profile_id']);

	$profile_reference = 'reference0';
	$data = $client->profile->scoring->list(new ProfileReference($profile_reference),
                                          $source_id);
	print($data['profile_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile/scoring?source_id=source_id&profile_id=profile_id" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')

resp = client.profile.scoring.list(profile_id='7c94e981cd23d16f5c549eea21a7554db0c927a7', source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7')
print(resp['data'][0]['type'])

resp = client.profile.scoring.list(profile_referrence='reference0', source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7')
print(resp['data'][0]['type'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "34t4e981cd232l6f5c549eegh1a7554db0d2256y";
    var profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    var profile_ref = "349593";
    
    // With id
    var data0 = client.profile.scoring.list(source_id, profile_id);
    Console.WriteLine(data0[0].score);
    
    // With reference
    var data1 = client.profile.scoring.list(source_id, profile_reference: profile_ref);
    Console.WriteLine(data1[0].score);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.Ident;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    String source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    String profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    String profile_reference = "refernce0";
    
    Map<String, Token> data0 = client.Profile().Scoring().list(source_id, new Ident.ID(Ident.Profile, profile_id));
    System.out.println(data0.get(0).getMap().get("filter_id").as());
    
    Map<String, Token> data1 = client.Profile().Scoring().list(source_id, new Ident.Reference(Ident.Profile, profile_reference));
    System.out.println(data1.get(0).getMap().get("filter_id").as());
  }
require 'riminder'

client = Riminder.new('api_key')

source_id = "6386f54e6009b1b976d1a24935191edce20f0817"
profile_id = "4594e981cd23d16f5c549eea21a7554db0c92745"
profile_reference = "reference0"

data0 = client.profile.scoring.list "source_id" => source_id, "profile_id" => profile_id
puts(data0[0]['score'])
data1 = client.profile.scoring.list "source_id" => source_id, "profile_reference" => profile_reference
puts(data1[0]['score'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")

	sourceID := "6386f54e6009b1b976d1a24935191edce20f0817"
	profileID := "4594e981cd23d16f5c549eea21a7554db0c92745"
	profileReference := "reference0"

	data0, _ := client.Profile().Scoring().List(map[string]interface{}{"source_id": sourceID, "profile_id": profileID})
	fmt.Println(data0[0].FilterID)
  
	data1, _ := client.Profile().Scoring().List(map[string]interface{}{"source_id": sourceID, "profile_reference": profileReference})
	fmt.Println(data1[0].FilterID)

}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": [
    {
      "filter_id": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
      "filter_reference": "12039",
      "template": {
	      "name": "Sales Assistant",      
      },
      "score": 0.916630151076242,
      "rating": 4,      
      "stage": "YES",
			"private_url": "subdomain.riminder.net/?..."    
    },
    {
      "filter_id": "c455582f41f589213a7d34ccb3954c67476077da",
      "filter_reference": "36385",
      "template": {
      	"name": "Sales Engineer",
      },
      "score": 0.814219107106328,
      "rating": 3,      
      "stage": "LATER",
      "private_url": "subdomain.riminder.net/?..."
    },
    {
      "filter_id": "f201877db6a1701ba05d025600a36ab43f0c0445",
      "filter_reference": "97463",
      "template": {
     		"name": "Telemarketer",
      },
      "score": 0.664479256980121,
      "rating": 2,      
      "stage": "LATER",
      "private_url": "subdomain.riminder.net/?..."    
    },
    {
      "filter_id": "33db7f7d41146219b3dcb921fe2295b159f9c103",
      "filter_reference": "25367",
      "template": {
      	"name": "Purchasing Manager",
      },
      "score": 0.55896331537515,
      "rating": 1,      
      "stage": "NO",
      "private_url": "subdomain.riminder.net/?..."
    },
    {
      "filter_id": "3c363836cf4e16666669a25da280a1865c2d2874",
      "filter_reference": "25368",
      "template": {
      	"name": "Recruiter",
      },
      "score": 0.1080265596509,
      "rating": 1,      
      "stage": "NO",
      "private_url": "subdomain.riminder.net/?..."
    }
  ]
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Query Params

source_id
string
required

source id associated to the profile.

profile_id
string

profile id.

profile reference
string

profile_reference.

 

Reponse

Field
Type
Description

filter_id

string

filter id.

filter_reference

string

filter reference (customizable in the filter edition modal).

template

object

template associated to the filter.

template.name

string

template name.

score

float

profile score associated to the job ([0,1]).

rating

integer

profile rating from 1 to 4 associated to the job.

stage

string

profile stage associated to the job (YES,LATER,NO, NEW).

private_rul

string

private url associated to the scoring of the profile.

Suggest Edits

/profile/stage

Edit the profile stage given a filter.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://www.riminder.net/sf/public/api/v1.0/profile/stage
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  source_id: "source_id",
  stage: Stage.NO,
  profile_id: "profile_id",
  // or
  profile_reference: "profile_reference",
  filter_id: "filter_id",
  // or
  filter_reference: "filter_reference"
}

app.profile.stage.set(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');

	$profile_id = '7c14e981cd232l6f5c549eea21a7554db0d221a7';
	$source_id = 'a34ze981cd232l6f5c549yea21a7554db0d234rt';
	$filter_id = 'ert6e981cd232l6f5c549eea27a7554db0d256ui';
	$stage = 'ALL';
	$data = $client->profile->rating->set(new ProfileID($profile_reference), $source_id,
                                        new FilterID($filter_reference), $stage);
	print($data['profile_id']);

	$profile_reference = 'reference1';
	$source_id = 'a34ze981cd232l6f5c549yea21a7554db0d234rt';
	$filter_reference = 'reference0';
	$stage = 'ALL';
	$data = $client->profile->rating->set(new ProfileReference($profile_reference),
                                        $source_id,
                                        new FilterReference($filter_reference), $stage);
	print($data['profile_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile/stage" \
--request PATCH \
--data "{ \"source_id\":\"source_id\",\"profile_reference\":\"reference\",\"filter_id\":\"filter_id\",\"stage\":\"NO\"}" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')

resp = client.profile.stage.set(profile_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                                source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                                filter_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                                stage='YES')
print(resp['data']['profile_id'])

resp = client.profile.stage.set(profile_referrence='reference0',
                                source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                                filter_reference='reference+1', 
                                stage='YES')
print(resp['data']['profile_id'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "34t4e981cd232l6f5c549eegh1a7554db0d2256y";
    var profile_id = "215de6cb5099f4895149ec0a6ac91be94ffdd246";
    var profile_ref = "49583";
    var filter_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    var filter_ref = "1248593";
    var stage = "YES";
    
    // With id
    var data0 = client.profile.stage.set(source_id, stage, profile_id, 
                                        filter_id: filter_id);
    Console.WriteLine(data0 stage);
    
    // With reference
    var data1 = client.profile.stage.set(source_id, stage, profile_reference: profile_ref,
                                         filter_reference: filter_ref);
    Console.WriteLine(data1.stage);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.Ident;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    String source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    String profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    String profile_reference = "refernce0";
    String filter_id = "102b6aa635fnf8ar70e7888ee63c0jde0c75erty";
    String filter_reference = "refernce0";
    
    Map<String, Token> data0 = client.Profile().Stage().set(source_id, "NEW", new Ident.ID(Ident.Profile, profile_id), Ident.ID(Ident.Filter, filter_id));
    System.out.println(data0.get(0).getMap().get("filter_id").as());
    
    Map<String, Token> data1 = client.Profile().Stage().set(source_id, "NEW",new Ident.Reference(Ident.Profile, profile_reference), Ident.Reference(Ident.Filter, filter_reference));
    System.out.println(data1.get(0).getMap().get("filter_id").as());
  }
require 'riminder'

client = Riminder.new('api_key')

source_id = "6386f54e6009b1b976d1a24935191edce20f0817"
profile_id = "4594e981cd23d16f5c549eea21a7554db0c92745"
profile_reference = "reference0"
filter_id = "6794e981cd23d45f5c549eea21a7554db0c92734"
filter_reference = "reference1"
stage = "YES"

data0 = client.profile.stage.set "source_id" => source_id, "profile_id" => profile_id, "filer_id" => filter_id, "stage" => stage
puts(data0['profile_id'])

data1 = client.profile.stage.set "source_id" => source_id, "profile_reference" => profile_reference, "filer_reference" => filter_reference, "stage" => stage
puts(data1['profile_id'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")

	sourceID := "6386f54e6009b1b976d1a24935191edce20f0817"
	profileID := "4594e981cd23d16f5c549eea21a7554db0c92745"
	profileReference := "reference0"
	filterID := "6794e981cd23d45f5c549eea21a7554db0c92734"
	filterReference := "reference1"
	stage := "YES"

	data0, _ := client.Profile().Stage().Set(map[string]interface{}{"source_id": sourceID, "profile_id": profileID, "filter_id": filterID, "stage": stage})
	fmt.Println(data0.Stage)
  
	data1, _ := client.Profile().Stage().Set(map[string]interface{}{"source_id": sourceID, "profile_reference": profileReference, "filter_reference": filterReference, "stage": stage})
	fmt.Println(data1.Stage)

}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "OK",
  "data": {
    "profile_id": "215de6cb5099f4895149ec0a6ac91be94ffdd246",
    "profile_reference": "49583",
    "filter_id": "7c94e981cd23d16f5c549eea21a7554db0c927a7",
    "filter_reference": "1248593",
    "stage": "YES,
  },
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}
{
  "code": 400,
  "message": "Invalid status",
}

Body Params

source_id
string
required

source id associated to the profile.

profile_id
string

profile id.

profile_reference
string

profile reference.

filter_id
string

filter id.

filter_reference
string

filter reference

stage
string
required

profiles' stage associated to the filter ( null for all, NEW, YES, LATER or NO).

 

Reponse

Field
Type
Description

profile_id

string

profile id.

profile_reference

string

profile reference (customizable in the PROFILE API POST).

filter_id

string

filter id.

filter_reference

string

filter reference (customizable in the filter edition modal).

stage

string

profile stage associated to the filter (YES,LATER,NO, NEW).

Suggest Edits

/profile/rating

Edit the profile rating given a filter.

 

Header Auth

 Authentication is required for this endpoint.
patchhttps://www.riminder.net/sf/public/api/v1.0/profile/rating
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  source_id: "source_id",
  rating: 3,
  profile_id: "profile_id",
  // or
  profile_reference: "profile_reference",
  filter_id: "filter_id",
  // or
  filter_reference: "filter_reference"
}

app.profile.rating.set(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');

	$profile_id = '7c14e981cd232l6f5c549eea21a7554db0d221a7';
	$source_id = 'a34ze981cd232l6f5c549yea21a7554db0d234rt';
	$filter_id = 'ert6e981cd232l6f5c549eea27a7554db0d256ui';
	$rating = '1';
	$data = $client->profile->rating->set(new ProfileID($profile_id), $source_id,
                                        new FilterID($filter_id), $rating);
	print($data['profile_id']);

	$profile_reference = 'reference1';
	$source_id = 'a34ze981cd232l6f5c549yea21a7554db0d234rt';
	$filter_reference = 'reference0';
	$rating = '3';
	$data = $client->profile->rating->set(new ProfileReference($profile_reference),
                                        $source_id, 
                                        new FilterReference($filter_reference), $rating);
	print($data['profile_id']);
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile/rating" \
--request PATCH \
--data "{ \"source_id\":\"source_id\",\"profile_reference\":\"reference\",\"filter_id\":\"filter_id\",\"rating\":1}" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')
resp = client.profile.rating.set(profile_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                                 source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                                 filter_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                                 rating=3)
print(resp['data']['profile_id'])

resp = client.profile.rating.set(profile_referrence='reference0',
                                 source_id='7c94e981cd23d16f5c549eea21a7554db0c927a7',
                                 filter_reference='reference+1', 
                                 rating=3)
print(resp['data']['profile_id'])
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "34t4e981cd232l6f5c549eegh1a7554db0d2256y";
    var profile_id = "215de6cb5099f4895149ec0a6ac91be94ffdd246";
    var profile_ref = "49583";
    var filter_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    var filter_ref = "1248593";
    var rating = 1;
    
    // With id
    var data0 = client.profile.rating.set(source_id, rating, profile_id, 
                                          filter_id: filter_id);
    Console.WriteLine(data0.rating);
    
    // With reference
    var data1 = client.profile.rating.set(source_id, rating, 
                                          profile_reference: profile_ref,
                                          filter_reference: filter_ref);
    Console.WriteLine(data1.rating);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.Ident;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    String source_id = "7c94e981cd23d16f5c549eea21a7554db0c927a7";
    String profile_id = "102b6aa635fnf8ar70e7888ee63c0jde0c753dtg";
    String profile_reference = "refernce0";
    String filter_id = "102b6aa635fnf8ar70e7888ee63c0jde0c75erty";
    String filter_reference = "refernce0";
    
    Map<String, Token> data0 = client.Profile().Rating().set(source_id, 1, new Ident.ID(Ident.Profile, profile_id), Ident.ID(Ident.Filter, filter_id));
    System.out.println(data0.get(0).getMap().get("filter_id").as());
    
    Map<String, Token> data1 = client.Profile().Rating().set(source_id, 1,new Ident.Reference(Ident.Profile, profile_reference), Ident.Reference(Ident.Filter, filter_reference));
    System.out.println(data1.get(0).getMap().get("filter_id").as());
  }
require 'riminder'

client = Riminder.new('api_key')

source_id = "6386f54e6009b1b976d1a24935191edce20f0817"
profile_id = "4594e981cd23d16f5c549eea21a7554db0c92745"
profile_reference = "reference0"
filter_id = "6794e981cd23d45f5c549eea21a7554db0c92734"
filter_reference = "reference1"
rating = 3

data0 = client.profile.rating.set "source_id" => source_id, "profile_id" => profile_id, "filer_id" => filter_id, "rating" => rating
puts(data0['profile_id'])

data1 = client.profile.rating.set "source_id" => source_id, "profile_reference" => profile_reference, "filer_reference" => filter_reference, "rating" => rating
puts(data1['profile_id'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")

	sourceID := "6386f54e6009b1b976d1a24935191edce20f0817"
	profileID := "4594e981cd23d16f5c549eea21a7554db0c92745"
	profileReference := "reference0"
	filterID := "6794e981cd23d45f5c549eea21a7554db0c92734"
	filterReference := "reference1"
	rating := 2

	data0, _ := client.Profile().Rating().Set(map[string]interface{}{"source_id": sourceID, "profile_id": profileID, "filter_id": filterID, "rating": rating})
	fmt.Println(data0.Rating)
  
	data1, _ := client.Profile().Rating().Set(map[string]interface{}{"source_id": sourceID, "profile_reference": profileReference, "filter_reference": filterReference, "stage": rating})
	fmt.Println(data1.Rating)

}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "OK",
  "data": {
    "profile_id": "215de6cb5099f4895149ec0a6ac91be94ffdd246",
    "profile_reference": "49583",
    "filter_id": "7c94e981cd23d16f5c549eea21a7554db0c927a7",
    "filter_reference": "1248593",
    "rating": 3,
  },
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}
{
  "code": 400,
  "message": "Invalid status",
}

Body Params

source_id
string
required

source id associated to the profile

profile_id
string

profile id.

profile_reference
string

profile reference.

filter_id
int32

filter id.

filter_reference
string

filter reference.

rating
string
required

profile rating from 1 to 4 associated to the filter.

 

Reponse

Field
Type
Description

profile_id

string

profile id.

profile_reference

string

profile reference (customizable in the PROFILE API POST).

filter_id

string

filter id.

filter_reference

string

filter reference (customizable in the filter edition modal).

rating

integer

profile rating from 1 to 4 associated to the job.

Suggest Edits

/profile/revealing

Reveal the profile's justification of the assessment related to the given filter.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://www.riminder.net/sf/public/api/v1.0/profile/revealing
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key" });

const options = {
  source_id: "source_id",
  profile_id: "profile_id",
  // or
  profile_reference: "profile_reference",
  filter_id: "filter_id",
  //or
  filter_reference: "filter_reference"
}

app.profile.revealing.get(options).then(data => {
  // Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');

	$source_id = 'source_id';
	$profile_id = 'profile_id';
	// or
	$profile_reference = 'profile_reference';
	$filter_id = 'filter_id';
	// or
	$filter_reference = 'filter_reference';

	$data = $client->profile->revealing->get(new ProfileID($profile_id),
                                        // or
                                        new ProfileReference($profile_reference),
                                        new FilterID($filter_id),
                                        // or
                                        new FilterReference($filter_reference),
                                        $source_id);
	print(json_encode($data));
?>
curl --url "https://www.riminder.net/sf/public/api/v1.0/profile/revealing?source_id=source_id&profile_id=profile_id&filter_reference=filter_reference" --header "X-API-KEY: api_key"
import riminder 

client = riminder.Riminder('api_key')

resp = client.profile.revealing.get(source_id='source_id',
                                 profile_id='profile_id',
                                 # or
                                 profile_reference='profile_reference',
                                 filter_id='filter_id',
                                 # or
                                 filter_reference='filter_reference'))

print(resp.content)
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var source_id = "source_id";
    var profile_id = "proile_id";
    // or
    var profile_reference = "profile_reference";
    var filter_id = "filter_id";
    // or
    var filter_reference = "filter_reference";
    
    var data = client.profile.revealing.get(source_id: source_id,
                                          profile_id: profile_id,
                                          // or
                                          profile_reference: profile_reference,
                                          filter_id: filter_id,
                                          // or
                                         filter_reference: filter_reference);
    Console.WriteLine(data.skills.hardSkills);
  }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.Ident;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    
    String source_id = "source_id";
    String profile_id = "profile_id";
    // or
    String profile_reference = "profile_reference";
    String filter_id = "filter_id";
    // or
    String filter_reference = "filter_reference";
    
    Map<String, Token> data = client.Profile().Revealing().get(
      source_id,
      new Ident.ID(Ident.Profile, profile_id),
      // or
      new Ident.Reference(Ident.Profile, profile_reference),
      new Ident.ID(Ident.Filter, filter_id),
      // or
      new Ident.Reference(Ident.Filter, filter_reference));
      
    System.out.println(data.get("skills").as());
  }
}
require 'riminder'

client = Riminder.new('api_key')

source_id = "source_id"
profile_id = "profile_id"
# or
profile_reference = "profile_reference"
filter_id = "filter_id"
# or
filter_reference = "filter_reference"

data = client.profile.revealing.get "source_id" => source_id,
"profile_id" => profile_id,
# or 
"profile_reference" => profile_reference,
"filter_id" => filter_id
# or
"filter_reference" => filter_reference

puts(data)
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")

	sourceID := "sourceID"
	profileID := "profileID"
  // or
	profileReference := "profileReference"
  filterID := "filterID"
  // or
  filterReference := "filterReference"

	data, _ := client.Profile().Revealing().Get(map[string]interface{}{"source_id": sourceID, "profile_id": profileID, "filter_id": filterID})
	fmt.Println(data.HardSkills)

}
A binary file was returned

You couldn't be authenticated

{
	"code": 200,
	"message": "OK",
	"data": {
		"profile": {
			"experiences": [{
				"startDate": 1483228800,
				"score": "0.16788772",
				"endDate": 1514764800,
				"description": [{
					"score": "0.0",
					"word": "Fujitsu"
				}, {
					"score": "0.0",
					"word": "company"
				}],
				"title": [{
					"score": "0.5750217",
					"word": "CusCo"
				}, {
					"score": "0.3541478",
					"word": "employee"
				}],
				"company": [{
					"score": "0.0",
					"word": "CusCo"
				}]
			}],
			"educations": [{
				"startDate": 473385600,
				"school": [{
					"score": "0.0",
					"word": "Hill"
				}, {
					"score": "0.0",
					"word": "Valley"
				}, {
					"score": "0.0",
					"word": "High"
				}, {
					"score": "0.0",
					"word": "School"
				}],
				"score": "0.0",
				"endDate": 504921600,
				"description": [{
					"score": "0.0",
					"word": "a"
				}, {
					"score": "0.0",
					"word": "school"
				}],
				"title": [{
					"score": "0.6934995",
					"word": "Hill"
				}, {
					"score": "0.016087469",
					"word": "Valley"
				}, {
					"score": "0.0",
					"word": "High"
				}, {
					"score": "0.0",
					"word": "School"
				}]
			}]
		},
		"skills": {
			"softSkills": [{
				"score": "0.15199988",
				"word": "a"
			}],
			"transversalSkills": [],
			"specialSkills": [],
			"hardSkills": [{
				"score": "0.03785004",
				"word": "music"
			}]
		}
	}
}
{
  "code": 400,
  "message": "Bad Request",
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}

Query Params

source_id
string
required

source id associated with the profile.

profile_id
string

profile id.

profile_reference
string

profile reference.

filter_id
string

filter id.

filter_reference
string

filter reference

 
Suggest Edits

Authentication

 

Authentication to all WEBHOOK API endpoints are using your WEBSITE API key (Getting Started)

Suggest Edits

/webhook/check

Check webhook integration for given team account

 

Header Auth

 Authentication is required for this endpoint.
posthttps://www.riminder.net/sf/public/api/v1.0/webhook/check
import Riminder from "riminder";
const app = new Riminder({ API_Key: "api_key", Webhooks_Key: "webhook_key" });

app.webhooks.check().then((response) => {
	// Your treatment here
});
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key');

	$data = $client->webhook->check();
	print($data['team_name']);
?>
import riminder 

client = riminder.Riminder('api_key')
resp = client.webhook.check()

print(resp['data']['team_name'])
curl --request POST \
  --url https://www.riminder.net/sf/public/api/v1.0/webhook/check
using System;
using Riminder;

public class RiminderExample
{
 	public static void Main()
  {
    var client = Riminder.Riminder("api_key");
    
    var data = client.webhooks.check();
    Console.WriteLine(data.team_name);
  }
}

import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import java.utils.*;

public class RiminderExample
{
 	public static void Main( String[] args )
  {
    Riminder client = Riminder("api_key");
    Map<String, Token> data = client.Webhooks().check();
    System.out.println(data.get("team_name").as());
  }
}

require 'riminder'

client = Riminder.new('api_key')
data = client.webhooks.check

puts(data['team_name'])
package main
import (
	"fmt"

	"github.com/Riminder/go-riminder-api/riminder"
)

func main() {
	client := riminder.New("api_key")
	data, _ := client.Webhooks().Check()

	fmt.Println(data.TeamName)

}
A binary file was returned

You couldn't be authenticated

{
  "code": 200,
  "message": "ok",
  "data": {
      "team_name": "OGGOLE",
      "webhook_id": "htjfkofotrkgjhrrhjgdfp",
      "webhook_url": "https://oggole.com/webhook/riminder",			
   },
}
{
  "code": 401,
  "message": "Unauthorized",
}
{
  "code": 403,
  "message": "Forbidden",
}
{
  "code": 400,
  "message": "Bad Request",
}

Body Params

url
string

Webhook callback url.

type
string

Webhook type.

 

Response

Field
Type
Description

team_name

string

team name.

webhook_id

string

webhook id.

url

string

webhook url where your account events will be sent
(customizable in the webhook integration edition modal).

type

string

webhook type of events
(customizable in the webhook integration edition modal).

Suggest Edits

Configuration

 

Signature

When WEBHOOK integration sends an event notification, a HTTP POST request is made to your specified WEBHOOK URL. This POST request will contain some parameters, including the HTTP-RIMINDER-SIGNATURE header parameter which you can use for authorization.

The HTTP-RIMINDER-SIGNATURE is base64url encoded and signed with an HMAC version of your WEBHOOK SECRET KEY with the SHA-256 digest.

What this means is that when it is POSTed to your WEBHOOK SECRET KEY, you will need to parse and verify it before it can be used. This is performed in three steps:

  • Split the signed request into two parts delineated by a '.' character (eg. 238fsdfsd.oijdoifjsidf899)
  • Decode the first part - the encoded signature - from base64url
  • Decode the second part - the payload - from base64url and then decode the resultant JSON object

These steps are possible in any modern programming language.


<?php

function parse_signed_request($signed_request, $secret) {
  list($encoded_sig, $payload) = explode('.', $signed_request, 2); 

  // decode the data
  $sig = base64_url_decode($encoded_sig);
  $data = json_decode(base64_url_decode($payload), true);

  // confirm the signature
  $expected_sig = hash_hmac('sha256', $payload, $secret, $raw = true);
  if ($sig !== $expected_sig) {
    error_log('Bad Signed JSON signature!');
    return null;
  }

  return $data;
}

function base64_url_decode($input) {
  return base64_decode(strtr($input, '-_', '+/'));
}
import hmac
import hashlib

def check_signature(request_signature, secret_key, request_body):

    hasher = hmac.new(secret_key, request_body, hashlib.sha256)
    dig = hasher.hexdigest()

    return hmac.compare_digest(dig, request_signature)

req_sig = '9d101d2bf630748679226b767d2031634c520390ff0e926afc09bc65a05bfdb2'
req_body = '4567'
secret_key = '1234'

print(check_signature(secret_key, req_sig, req_body))
require 'openssl'

def check_signature(secret_key, request_signature, request_body)

  digest = OpenSSL::Digest.new('sha256')

  hmac = OpenSSL::HMAC.new(secret_key, digest)
  hmac.update(request_body)
  hmac.to_s == request_signature
end

# req_sig = request.headers['HTTP-RIMINDER-SIGNATURE']
# req_body = request.body.read
# secret_key = ENV['RIMINDER_WEBHOOK_KEY']

req_sig = '9d101d2bf630748679226b767d2031634c520390ff0e926afc09bc65a05bfdb2'
req_body = '4567'
secret_key = '1234'

puts check_signature(secret_key, req_sig, req_body)

HMAC algorithm with SHA-256 digest

Suggest Edits

Events

Webhook Events that will be sent to your account

 

FORMAT

The webhook posts data to the URL you provided in the configuration. The body is encoded in JSON, which is indicated by the application/json content-type, with UTF-8 encoding (as stated in RFC 4627 (http://www.ietf.org/rfc/rfc4627.txt).

EVENTS TYPES

Riminder can send a few different events types to your application. Each call to the webhook URL will send an array of payloads.

PAYLOAD
EVENT
STATUS
TYPE
DESCRIPTION
VOLUME

profile

parsing

success or error

profile.parse.success or profile.parse.error

Notification of the profile parsing status.

High volume

profile

scoring

success or error

profile.score.success or profile.score.error

Notification of profile scoring status.

Medium volume

filter

training

success or error
start

filter.train.success or filter.train.error or filter.train.start

Notification of filter training status.

Low volume

filter

scoring

success or error
start

filter.score.success or filter.score.error or filter.score.start

Notification of filter scoring status.

Low volume

action

stage

success or error

action.stage.success or action.stage.error

Notification of action stage status.

Low volume

action

rating

success or error

action.rating.success or action.rating.error

Notification of action rating status.

Low volume

Handling an event

Handling an event is very simple. You can specify callback function to handle every event incoming on your webhooks endpoint. Each event must have its own handling function.

Requirements

  • The request header
  • The API secret key
  • The webhook secret key
  • An endpoint receiving post requests

Example

import Riminder from "riminder";

function handleProfileParseStart(webhooksData, eventName) {
	console.log(webhooksData);
}

const client = new Riminder({ API_Key: "api_key", Webhooks_Key: "webhooks_key"});
client.webhooks.on("profile.parse.start", handleProfileParseStart);

// ...
// ...
// ...

router.post("/webhooks", client.webhooks.handle(request.header));
// The server will output every "profile.parse.start" event in the console
<?php
	require __DIR__ . '/vendor/autoload.php';

	$client = new Riminder('api_key', 'webhook_key');

	// Set an handler for webhook event.
	$callback = function($event_name, $webhook_data) {
    	print($event_name);
    	var_dump($webhook_data);
  	};
	$client->webhooks->setHandler('profile.parse.success', $callback);

	// Get the header of the request sent by the webhook.
	$rcvheaders = function_that_get_webhook_request_headers();

  	// Handle the webhook
	$client->webhooks->handle($rcvheaders);
?>

import riminder 

def func_callback(event_name, webhook_data):
  print("{} {}".format(event_name, webhook_data)

client = riminder.Riminder('api_key', webhook_secret='webhook_key')

# Set an handler for webhook event.
callback = func_callback
resp = client.webhooks.setHandler('profile.parse.success', callback)
        
# Get the header of the request sent by the webhook.
rcvheaders = function_that_get_webhook_request_headers()
        
# Handle the webhook
client.webhooks.handle(request_headers=rcvheaders)

using System;
using Riminder;
using Riminder.route;

public class Example
{
    static void Main()
    {
        var client = new Riminder("apikey");

        // Define an handler
        var handler = delegate (string eventName, response.IWebhookMessage webhook_data) { /* something */};

        // Set the handler for an event
        client.webhooks.setHandler(Webhook.EventNames.PROFILE_PARSE_SUCCESS, handler);

        // Get the header of the request by webhook
        var rcvheaders = function_that_get_webhook_request_headers();

        // Handle an event
        client.webhooks.handle(headers: rcvheaders);
    }
}
import net.riminder.riminder.Riminder;
import net.riminder.riminder.response.Token;
import net.riminder.riminder.route.Webhooks;
import net.riminder.riminder.route.Webhooks.MessageHandler;

public class Example
{
    public static void main( String[] args ) {
        Riminder client = new Riminder("apikey");

        // Define an handler
        MessageHandler handler = new MessageHandler(){
        
            @Override
            public void handle(String eventName, Map<String, Token> webhook_data) {
                // some treatment
            }
        };
        

        // Set the handler for an event
        client.Webhooks().setHandler(Webhooks.EventNames.PROFILE_PARSE_SUCCESS, handler);

        // Get the header of the request by webhook
        Map<String, String> rcvheaders = function_that_get_webhook_request_headers();

        // Handle an event
        client.Webhooks().handle(headers: rcvheaders.get("HTTP-RIMINDER-SIGNATURE"));
    }
}
require 'riminder'

client = Riminder.new("api_key", "webhook_key")

# Create a callable callback.
callback  = -> (event_name, webhook_data) {
    # some treatment here
}

# Set an handler for webhook event.
api.webhooks.setHandler "profile.parse.success", callback

# Get the header of the request sent by the webhook.
rcvheaders = function_that_get_webhook_request_headers()

# Handle the webhook
api.webhooks.handle rcvheaders
package main

import "github.com/Riminder/go-riminder-api/riminder"

func main() {
	client := riminder.New("api_key")
	client.SetWebhookKey("webhook_key")
	// Create a callable callback.
	callback := func(event_name string, webhook_data interface{}) {
		// some treatment here
	}

	// Set an handler for webhook event.
	client.Webhooks().SetHandler("profile.parse.success", callback)

	// Get the header of the request sent by the webhook.
	encodedHeader := map[string]string{"HTTP-RIMINDER-SIGNATURE": "some encoded datas"}

	// Handle the webhook
	client.Webhooks().Handle(encodedHeader)

}
Suggest Edits

profile.parse

 
Field
Type
Description

type

string

profile.parse.success or profile.parse.error

message

string

webhook description message.

profile

object

profile object.

profile.profile_id

string

profile id.

profile.profile_reference

string

profile reference (customizable in the PROFILE API POST).

Suggest Edits

profile.score

 
Field
Type
Description

type

string

profile.score.success or profile.score.error

message

string

webhook description message.

profile

object

profile object.

profile.profile_id

string

profile id.

profile.profile_reference

string

profile reference (customizable in the PROFILE API POST).

filter

object

filter associated to the profile score.

filter.filter_id

string

filter id.

filter.filter_reference

string

filter reference (customizable in the filter edition modal).

score

float

profile score associated to the filter.

Suggest Edits

filter.train

 
Field
Type
Description

type

string

filter.train.start or filter.train.success or filter.train.error

message

string

webhook description message.

filter

object

filter object.

filter.filter_id

string

filter id.

filter.filter_reference

string

filter reference (customizable in the PROFILE API POST).

Suggest Edits

filter.score

 
Field
Type
Description

type

string

filter.score.start or filter.score.success or filter.score.error

message

string

webhook description message.

filter

object

filter object.

filter.filter_id

string

filter id.

filter.filter_reference

string

filter reference (customizable in the PROFILE API POST).

Suggest Edits

action.stage

 
Field
Type
Description

type

string

action.stage.success or action.stage.error

message

string

webhook description message.

profile

object

profile object.

profile.profile_id

string

profile id.

profile.profile_reference

string

profile reference (customizable in the PROFILE API POST).

filter

object

filter associated to the profile score.

filter.filter_id

string

filter id.

filter.filter_reference

string

filter reference (customizable in the filter edition modal).

stage

string

profiles' stage associated to the filter (YES, LATER or NO).

Suggest Edits

action.rating

 
Field
Type
Description

type

string

action.rating.success or action.rating.error

message

string

webhook description message.

profile

object

profile object.

profile.profile_id

string

profile id.

profile.profile_reference

string

profile reference (customizable in the PROFILE API POST).

filter

object

filter associated to the profile score.

filter.filter_id

string

filter id.

filter.filter_reference

string

filter reference (customizable in the filter edition modal).

rating

integer

profile rating from 1 to 4 associated to the filter.